diff --git a/docs/command/atlas-api-alerts-listAlerts.txt b/docs/command/atlas-api-alerts-listAlerts.txt index fc8e60e9c6..2033467828 100644 --- a/docs/command/atlas-api-alerts-listAlerts.txt +++ b/docs/command/atlas-api-alerts-listAlerts.txt @@ -88,7 +88,7 @@ Options * - --status - string - false - - Status of the alerts to return. Omit to return all alerts in all statuses. + - Status of the alerts to return. Omit this parameter to return all alerts in all statuses. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. * - --version - string - false diff --git a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt index caa10ec372..ddf1e93947 100644 --- a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt @@ -17,7 +17,7 @@ atlas api cloudProviderAccess createCloudProviderAccessRole The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. -Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting Service Account or API Key must have the Project Owner role. +Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting Service Account or API Key must have the Project Owner role. For the GCP provider, if the project folder is not yet provisioned, Atlas will now create the role asynchronously. An intermediate role with status IN_PROGRESS will be returned, and the final service account will be provisioned. Once the GCP project is set up, subsequent requests will create the service account synchronously. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcloudprovideraccessrole. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt index 9e76d9dc37..8c47c0f3d4 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt @@ -90,6 +90,10 @@ Options - string - true - Unique 24-hexadecimal digit string that identifies the team whose application users you want to return. + * - --userId + - string + - false + - Unique 24-hexadecimal digit string to filter users by. Not supported in deprecated versions. * - --username - string - false diff --git a/docs/command/atlas-api-rollingIndex.txt b/docs/command/atlas-api-rollingIndex.txt index dc75943a4f..56cbda56f4 100644 --- a/docs/command/atlas-api-rollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex.txt @@ -17,7 +17,7 @@ atlas api rollingIndex The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. -You can't create a rolling index on an M0 free cluster or M2/M5 shared cluster. +Rolling indexes build indexes on the applicable nodes sequentially and may reduce the performance impact of an index build if your deployment's average CPU utilization exceeds (N-1)/N-10% where N is the number of CPU threads available to mongod of if the WiredTiger cache fill ratio regularly exceeds 90%. If your deployment does not meet this criteria, use the default index build. You can't create a rolling index on an M0 free cluster or M2/M5 shared cluster. Options ------- diff --git a/docs/command/includes/deleteTransitGatewayRoute-preview-default.sh b/docs/command/includes/deleteTransitGatewayRoute-preview-default.sh deleted file mode 100644 index edd988dcf9..0000000000 --- a/docs/command/includes/deleteTransitGatewayRoute-preview-default.sh +++ /dev/null @@ -1 +0,0 @@ -deleteTransitGatewayRoute --version preview --groupId 32b6e34b3d91647abb20e7b8 --routeId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/getTransitGatewayRoute-preview-default.sh b/docs/command/includes/getTransitGatewayRoute-preview-default.sh deleted file mode 100644 index 5d95025b41..0000000000 --- a/docs/command/includes/getTransitGatewayRoute-preview-default.sh +++ /dev/null @@ -1 +0,0 @@ -getTransitGatewayRoute --version preview --groupId 32b6e34b3d91647abb20e7b8 --routeId 32b6e34b3d91647abb20e7b8 diff --git a/docs/command/includes/listTransitGatewayRoutes-preview-default.sh b/docs/command/includes/listTransitGatewayRoutes-preview-default.sh deleted file mode 100644 index 5169ba972b..0000000000 --- a/docs/command/includes/listTransitGatewayRoutes-preview-default.sh +++ /dev/null @@ -1 +0,0 @@ -listTransitGatewayRoutes --version preview --groupId 32b6e34b3d91647abb20e7b8 diff --git a/internal/api/commands.go b/internal/api/commands.go index 8dd6ac4269..e1e8a93c6f 100644 --- a/internal/api/commands.go +++ b/internal/api/commands.go @@ -1227,7 +1227,7 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, { Name: `status`, - Description: `Status of the alerts to return. Omit to return all alerts in all statuses.`, + Description: `Status of the alerts to return. Omit this parameter to return all alerts in all statuses. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved.`, Short: ``, Required: false, Type: shared_api.ParameterType{ @@ -6093,7 +6093,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you { OperationID: `createCloudProviderAccessRole`, Aliases: nil, - Description: `Creates one access role for the specified cloud provider. Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + Description: `Creates one access role for the specified cloud provider. Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting Service Account or API Key must have the Project Owner role. For the GCP provider, if the project folder is not yet provisioned, Atlas will now create the role asynchronously. An intermediate role with status IN_PROGRESS will be returned, and the final service account will be provisioned. Once the GCP project is set up, subsequent requests will create the service account synchronously. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createcloudprovideraccessrole. @@ -18325,6 +18325,16 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c Type: `string`, }, }, + { + Name: `userId`, + Description: `Unique 24-hexadecimal digit string to filter users by. Not supported in deprecated versions.`, + Short: ``, + Required: false, + Type: shared_api.ParameterType{ + IsArray: false, + Type: `string`, + }, + }, }, URLParameters: []shared_api.Parameter{ { @@ -28446,7 +28456,7 @@ For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/c }, { 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.`, + Description: `Creates one index to a database deployment in a rolling manner. Rolling indexes build indexes on the applicable nodes sequentially and may reduce the performance impact of an index build if your deployment's average CPU utilization exceeds (N-1)/N-10% where N is the number of CPU threads available to mongod of if the WiredTiger cache fill ratio regularly exceeds 90%. If your deployment does not meet this criteria, use the default index build. You can't create a rolling index on an M0 free cluster or M2/M5 shared cluster.`, Commands: []shared_api.Command{ { OperationID: `createRollingIndex`, @@ -31927,56 +31937,6 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - { - OperationID: `createTransitGatewayRoute`, - Aliases: nil, - Description: `Creates a route in the default route table associated with Atlas VPC to route all traffic destined for provided CIDR to the provided Transit Gateway. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createtransitgatewayroute. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-createTransitGatewayRoute/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streamsTgwRoutes`, - QueryParameters: []shared_api.Parameter{ - { - Name: `envelope`, - Description: `Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `bool`, - }, - }, - }, - URLParameters: []shared_api.Parameter{ - { - Name: `groupId`, - Description: `Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. - - -NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - Aliases: []string{`projectId`}, - }, - }, - Verb: http.MethodPost, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewPreviewVersion(), - RequestContentType: `json`, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, { OperationID: `deletePrivateLinkConnection`, Aliases: nil, @@ -32277,66 +32237,6 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - { - OperationID: `deleteTransitGatewayRoute`, - Aliases: nil, - Description: `Deletes a transit gateway route in the default route table associated with Atlas VPC. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-deletetransitgatewayroute. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-deleteTransitGatewayRoute/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streamsTgwRoutes/{routeId}`, - QueryParameters: []shared_api.Parameter{ - { - Name: `envelope`, - Description: `Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `bool`, - }, - }, - }, - URLParameters: []shared_api.Parameter{ - { - Name: `groupId`, - Description: `Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. - - -NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - Aliases: []string{`projectId`}, - }, - { - Name: `routeId`, - Description: `The Object ID that uniquely identifies a transit gateway route.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - }, - Verb: http.MethodDelete, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewPreviewVersion(), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, { OperationID: `deleteVpcPeeringConnection`, Aliases: nil, @@ -32907,66 +32807,6 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - { - OperationID: `getTransitGatewayRoute`, - Aliases: nil, - Description: `Retrieves a transit gateway route in the default route table associated with Atlas VPC. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-gettransitgatewayroute. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-getTransitGatewayRoute/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streamsTgwRoutes/{routeId}`, - QueryParameters: []shared_api.Parameter{ - { - Name: `envelope`, - Description: `Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `bool`, - }, - }, - }, - URLParameters: []shared_api.Parameter{ - { - Name: `groupId`, - Description: `Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. - - -NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - Aliases: []string{`projectId`}, - }, - { - Name: `routeId`, - Description: `The Object ID that uniquely identifies a transit gateway route.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - }, - }, - Verb: http.MethodGet, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewPreviewVersion(), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, { OperationID: `getVpcPeeringConnections`, Aliases: nil, @@ -33407,76 +33247,6 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you }, }, }, - { - OperationID: `listTransitGatewayRoutes`, - Aliases: nil, - Description: `List Transit Gateway routes in the default route table associated with Atlas VPC. - -This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listtransitgatewayroutes. - -For more information and examples, see: https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api-streams-listTransitGatewayRoutes/`, - RequestParameters: shared_api.RequestParameters{ - URL: `/api/atlas/v2/groups/{groupId}/streamsTgwRoutes`, - QueryParameters: []shared_api.Parameter{ - { - Name: `envelope`, - Description: `Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `bool`, - }, - }, - { - Name: `itemsPerPage`, - Description: `Number of items that the response returns per page.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - { - Name: `pageNum`, - Description: `Number of the page that displays the current set of the total objects that the response returns.`, - Short: ``, - Required: false, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `int`, - }, - }, - }, - URLParameters: []shared_api.Parameter{ - { - Name: `groupId`, - Description: `Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. - - -NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.`, - Short: ``, - Required: true, - Type: shared_api.ParameterType{ - IsArray: false, - Type: `string`, - }, - Aliases: []string{`projectId`}, - }, - }, - Verb: http.MethodGet, - }, - Versions: []shared_api.CommandVersion{ - { - Version: shared_api.NewPreviewVersion(), - RequestContentType: ``, - ResponseContentTypes: []string{ - `json`, - }, - }, - }, - }, { OperationID: `modifyStreamProcessor`, Aliases: nil, diff --git a/tools/cmd/docs/metadata.go b/tools/cmd/docs/metadata.go index d490947f52..79f5b87696 100644 --- a/tools/cmd/docs/metadata.go +++ b/tools/cmd/docs/metadata.go @@ -1990,20 +1990,6 @@ var metadata = metadatatypes.Metadata{ }, Examples: nil, }, - `createTransitGatewayRoute`: { - OnlyPrivatePreview: true, - Parameters: map[string]metadatatypes.ParameterMetadata{ - `envelope`: { - Usage: `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.`, - }, - `groupId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. - -**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.`, - }, - }, - Examples: nil, - }, `createUser`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `envelope`: { @@ -3761,33 +3747,6 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `deleteTransitGatewayRoute`: { - OnlyPrivatePreview: true, - Parameters: map[string]metadatatypes.ParameterMetadata{ - `envelope`: { - Usage: `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.`, - }, - `groupId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. - -**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.`, - }, - `routeId`: { - Usage: `The Object ID that uniquely identifies a transit gateway route.`, - }, - }, - Examples: map[string][]metadatatypes.Example{ - `preview`: {{ - Source: `-`, - - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `routeId`: `32b6e34b3d91647abb20e7b8`, - }, - }, - }, - }, - }, `deleteVpcPeeringConnection`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `envelope`: { @@ -7594,33 +7553,6 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `getTransitGatewayRoute`: { - OnlyPrivatePreview: true, - Parameters: map[string]metadatatypes.ParameterMetadata{ - `envelope`: { - Usage: `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.`, - }, - `groupId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. - -**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.`, - }, - `routeId`: { - Usage: `The Object ID that uniquely identifies a transit gateway route.`, - }, - }, - Examples: map[string][]metadatatypes.Example{ - `preview`: {{ - Source: `-`, - - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - `routeId`: `32b6e34b3d91647abb20e7b8`, - }, - }, - }, - }, - }, `getUser`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `envelope`: { @@ -7923,7 +7855,7 @@ var metadata = metadatatypes.Metadata{ Usage: `Flag that indicates whether the response body should be in the prettyprint format.`, }, `status`: { - Usage: `Status of the alerts to return. Omit to return all alerts in all statuses.`, + Usage: `Status of the alerts to return. Omit this parameter to return all alerts in all statuses. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved.`, }, }, Examples: map[string][]metadatatypes.Example{ @@ -10839,6 +10771,9 @@ var metadata = metadatatypes.Metadata{ `teamId`: { Usage: `Unique 24-hexadecimal digit string that identifies the team whose application users you want to return.`, }, + `userId`: { + Usage: `Unique 24-hexadecimal digit string to filter users by. Not supported in deprecated versions.`, + }, `username`: { Usage: `Email address to filter users by. Not supported in deprecated versions.`, }, @@ -10890,35 +10825,6 @@ var metadata = metadatatypes.Metadata{ }, }, }, - `listTransitGatewayRoutes`: { - OnlyPrivatePreview: true, - Parameters: map[string]metadatatypes.ParameterMetadata{ - `envelope`: { - Usage: `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.`, - }, - `groupId`: { - Usage: `Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. - -**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.`, - }, - `itemsPerPage`: { - Usage: `Number of items that the response returns per page.`, - }, - `pageNum`: { - Usage: `Number of the page that displays the current set of the total objects that the response returns.`, - }, - }, - Examples: map[string][]metadatatypes.Example{ - `preview`: {{ - Source: `-`, - - Flags: map[string]string{ - `groupId`: `32b6e34b3d91647abb20e7b8`, - }, - }, - }, - }, - }, `loadSampleDataset`: { Parameters: map[string]metadatatypes.ParameterMetadata{ `envelope`: { diff --git a/tools/internal/specs/spec-with-overlays.yaml b/tools/internal/specs/spec-with-overlays.yaml index fe5c7c80d7..f6a567f17b 100644 --- a/tools/internal/specs/spec-with-overlays.yaml +++ b/tools/internal/specs/spec-with-overlays.yaml @@ -1777,7 +1777,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -2189,6 +2189,7 @@ components: ) when { context.cluster.regions.contains(cloud::region::"aws:us-east-1") }; + minLength: 1 type: string required: - body @@ -3275,7 +3276,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -6438,6 +6439,7 @@ components: - AWS_USAGE_REPORTED - AZURE_USAGE_REPORTED - GCP_USAGE_REPORTED + - VERCEL_USAGE_REPORTED - BECAME_PAYING_ORG - NEW_LINKED_ORG - UNLINKED_ORG @@ -8030,6 +8032,15 @@ components: pattern: ^([a-f0-9]{24})$ readOnly: true type: string + status: + description: Provision status of the service account. + enum: + - IN_PROGRESS + - COMPLETE + - FAILED + - NOT_INITIATED + readOnly: true + type: string type: object description: Details that describe the features linked to the GCP Service Account. required: @@ -8158,6 +8169,11 @@ components: items: $ref: '#/components/schemas/CloudProviderAccessAzureServicePrincipal' type: array + gcpServiceAccounts: + description: List that contains the Google Service Accounts registered and authorized with MongoDB Cloud. + items: + $ref: '#/components/schemas/CloudProviderAccessGCPServiceAccount' + type: array type: object CloudProviderAzureAutoScaling: description: Range of instance sizes to which your cluster can scale. @@ -8821,7 +8837,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -12200,7 +12216,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -13462,7 +13478,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -13540,6 +13556,7 @@ components: - CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS - CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES - CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID + - CLUSTER_CONNECTION_GET_AGGREGATED_VIEW_INFOS - CLUSTER_CONNECTION_AGGREGATE - CLUSTER_CONNECTION_CREATE_COLLECTION - CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES @@ -14156,6 +14173,7 @@ components: properties: clusterName: description: Label that identifies the destination cluster. + minLength: 1 type: string groupId: description: Unique 24-hexadecimal digit string that identifies the destination project. @@ -14168,6 +14186,7 @@ components: - PUBLIC - PRIVATE_LINK - VPC_PEERING + minLength: 1 type: string privateLinkId: description: Represents the endpoint to use when the host schema type is `PRIVATE_LINK`. @@ -14903,6 +14922,11 @@ components: $ref: '#/components/schemas/Link' readOnly: true type: array + region: + description: AWS region for the export bucket. This is set by Atlas and is never user-supplied. + example: us-east-1 + readOnly: true + type: string required: - _id - bucketName @@ -16413,6 +16437,7 @@ components: - CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS - CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES - CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID + - CLUSTER_CONNECTION_GET_AGGREGATED_VIEW_INFOS - CLUSTER_CONNECTION_AGGREGATE - CLUSTER_CONNECTION_CREATE_COLLECTION - CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES @@ -16571,6 +16596,8 @@ components: - HOST_MONGOT_CRASHING_OOM - HOST_MONGOT_RESUME_REPLICATION - HOST_MONGOT_STOP_REPLICATION + - HOST_MONGOT_SUFFICIENT_DISK_SPACE + - HOST_MONGOT_APPROACHING_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE - SSH_KEY_NDS_HOST_ACCESS_REQUESTED @@ -16688,6 +16715,7 @@ components: - ATLAS_MAINTENANCE_DEFERRED - ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED - ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED + - ATLAS_MAINTENANCE_RESET_BY_ADMIN - SCHEDULED_MAINTENANCE - PROJECT_SCHEDULED_MAINTENANCE - PROJECT_LIMIT_UPDATED @@ -16754,8 +16782,6 @@ components: - AUTO_HEALING_REQUESTED_CRITICAL_INSTANCE_POWER_CYCLE - AUTO_HEALING_REQUESTED_INSTANCE_REPLACEMENT - AUTO_HEALING_REQUESTED_NODE_RESYNC - - AUTO_HEALING_CANNOT_REPAIR_INTERNAL - - AUTO_HEALING_CANNOT_RESYNC_INTERNAL - EXTRA_MAINTENANCE_DEFERRAL_GRANTED - ADMIN_NOTE_UPDATED - GROUP_AUTOMATION_CONFIG_PUBLISHED @@ -16833,8 +16859,6 @@ components: - CLUSTER_IP_ROLLED_BACK - AZ_BALANCING_OVERRIDE_MODIFIED - FTDC_SETTINGS_UPDATED - - MONGOTUNE_ENABLED - - MONGOTUNE_DISABLED - PROXY_PROTOCOL_FOR_PRIVATE_LINK_MODE_UPDATED title: NDS Audit Types type: string @@ -17160,6 +17184,7 @@ components: - AWS_USAGE_REPORTED - AZURE_USAGE_REPORTED - GCP_USAGE_REPORTED + - VERCEL_USAGE_REPORTED - BECAME_PAYING_ORG - NEW_LINKED_ORG - UNLINKED_ORG @@ -20909,6 +20934,7 @@ components: - GROUP_OBSERVABILITY_VIEWER - GROUP_DATABASE_ACCESS_ADMIN type: string + minItems: 1 type: array secretExpiresAfterHours: description: The expiration time of the new Service Account secret, provided in hours. The minimum and maximum allowed expiration times are subject to change and are controlled by the organization's settings. @@ -20940,6 +20966,7 @@ components: - GROUP_OBSERVABILITY_VIEWER - GROUP_DATABASE_ACCESS_ADMIN type: string + minItems: 1 type: array uniqueItems: true required: @@ -21344,7 +21371,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -21383,6 +21410,8 @@ components: - HOST_MONGOT_CRASHING_OOM - HOST_MONGOT_RESUME_REPLICATION - HOST_MONGOT_STOP_REPLICATION + - HOST_MONGOT_SUFFICIENT_DISK_SPACE + - HOST_MONGOT_APPROACHING_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE - SSH_KEY_NDS_HOST_ACCESS_REQUESTED @@ -21409,6 +21438,7 @@ components: - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_CRASHING_OOM - HOST_MONGOT_STOP_REPLICATION + - HOST_MONGOT_APPROACHING_STOP_REPLICATION - HOST_NOT_ENOUGH_DISK_SPACE - SSH_KEY_NDS_HOST_ACCESS_REQUESTED - SSH_KEY_NDS_HOST_ACCESS_REFRESHED @@ -21844,7 +21874,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -24704,6 +24734,7 @@ components: description: List of migration hosts used for this migration. items: example: vm001.example.com + minLength: 1 type: string maxItems: 1 minItems: 1 @@ -26438,6 +26469,7 @@ components: - ATLAS_MAINTENANCE_DEFERRED - ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED - ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED + - ATLAS_MAINTENANCE_RESET_BY_ADMIN - SCHEDULED_MAINTENANCE - PROJECT_SCHEDULED_MAINTENANCE - PROJECT_LIMIT_UPDATED @@ -26504,8 +26536,6 @@ components: - AUTO_HEALING_REQUESTED_CRITICAL_INSTANCE_POWER_CYCLE - AUTO_HEALING_REQUESTED_INSTANCE_REPLACEMENT - AUTO_HEALING_REQUESTED_NODE_RESYNC - - AUTO_HEALING_CANNOT_REPAIR_INTERNAL - - AUTO_HEALING_CANNOT_RESYNC_INTERNAL - EXTRA_MAINTENANCE_DEFERRAL_GRANTED - ADMIN_NOTE_UPDATED - GROUP_AUTOMATION_CONFIG_PUBLISHED @@ -26583,8 +26613,6 @@ components: - CLUSTER_IP_ROLLED_BACK - AZ_BALANCING_OVERRIDE_MODIFIED - FTDC_SETTINGS_UPDATED - - MONGOTUNE_ENABLED - - MONGOTUNE_DISABLED - PROXY_PROTOCOL_FOR_PRIVATE_LINK_MODE_UPDATED example: CLUSTER_CREATED title: NDS Audit Types @@ -27605,7 +27633,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -28856,6 +28884,7 @@ components: - ORG_GROUP_CREATOR - ORG_OWNER type: string + minItems: 1 type: array secretExpiresAfterHours: description: The expiration time of the new Service Account secret, provided in hours. The minimum and maximum allowed expiration times are subject to change and are controlled by the organization's settings. @@ -29833,30 +29862,6 @@ components: readOnly: true type: integer type: object - PaginatedApiStreamsTransitGatewayRouteResponse: - properties: - links: - description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: '#/components/schemas/Link' - readOnly: true - type: array - results: - description: List of returned documents that MongoDB Cloud provides when completing this request. - items: - $ref: '#/components/schemas/StreamsTransitGatewayRouteResponse' - readOnly: true - type: array - totalCount: - description: Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact. - format: int32 - minimum: 0 - readOnly: true - type: integer - type: object PaginatedApiUserAccessListResponseView: properties: links: @@ -31471,6 +31476,10 @@ components: description: Password needed to allow MongoDB Cloud to access your Prometheus account. type: string writeOnly: true + sendUserProvidedResourceTagsEnabled: + default: false + description: Toggle sending user provided group and cluster resource tags with the prometheus metrics. + type: boolean serviceDiscovery: description: Desired method to discover the Prometheus service. enum: @@ -31955,7 +31964,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -32346,7 +32355,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -35357,6 +35366,7 @@ components: type: string clusterName: description: Label that identifies the source cluster name. + minLength: 1 type: string groupId: description: Unique 24-hexadecimal digit string that identifies the source project. @@ -35583,7 +35593,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -36562,38 +36572,6 @@ components: streamConfig: $ref: '#/components/schemas/StreamConfig' type: object - StreamsTransitGatewayRouteRequest: - description: Container for metadata needed to create a Transit Gateway route. - properties: - destinationCidr: - description: The route's destination CIDR. - type: string - region: - description: The region of the Atlas VPCs where this route should take effect. - type: string - tgwId: - description: The AWS ID of the Transit Gateway through which traffic will be routed. - type: string - type: object - StreamsTransitGatewayRouteResponse: - description: Container for metadata associated with a Transit Gateway route. - properties: - destinationCidr: - description: The route's destination CIDR. - type: string - region: - description: The region of the Atlas VPCs where this route should take effect. - type: string - tgwId: - description: The AWS ID of the Transit Gateway through which traffic will be routed. - type: string - tgwRouteId: - description: The ID of the Transit Gateway route. - example: 32b6e34b3d91647abb20e7b8 - pattern: ^([a-f0-9]{24})$ - readOnly: true - type: string - type: object SwapUsageFreeDataMetricThresholdView: properties: metricName: @@ -37859,7 +37837,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -39875,7 +39853,7 @@ info: termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions title: MongoDB Atlas Administration API version: "2.0" - x-xgen-sha: 8603db49332d5c974f57f05e4a4b43dad0697914 + x-xgen-sha: 53e2fb6c08b2e2450803352c94465369d16a6e64 openapi: 3.0.1 paths: /api/atlas/v2: @@ -40084,6 +40062,9 @@ paths: tags: - Federated Authentication x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/removeConnectedOrgConfig + x-xgen-method-verb-override: + customMethod: "True" + verb: remove get: description: Returns the specified connected org config from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. operationId: getConnectedOrgConfig @@ -40614,6 +40595,9 @@ paths: tags: - Federated Authentication x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/revokeJwksFromIdentityProvider + x-xgen-method-verb-override: + customMethod: "True" + verb: revoke /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml: get: description: Returns the metadata of one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. @@ -40643,6 +40627,9 @@ paths: tags: - Federated Authentication x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProviderMetadata + x-xgen-method-verb-override: + customMethod: "False" + verb: get /api/atlas/v2/groups: get: description: Returns details about all projects. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Organization Read Only role or higher. @@ -40901,6 +40888,9 @@ paths: tags: - Projects x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/addUserToProject + x-xgen-method-verb-override: + customMethod: "True" + verb: addUser /api/atlas/v2/groups/{groupId}/accessList: get: description: Returns all access list entries from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. @@ -41374,6 +41364,9 @@ paths: tags: - Alert Configurations x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration + x-xgen-method-verb-override: + customMethod: "True" + verb: toggle put: description: |- Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. @@ -41488,7 +41481,7 @@ paths: - $ref: '#/components/parameters/itemsPerPage' - $ref: '#/components/parameters/pageNum' - $ref: '#/components/parameters/pretty' - - description: Status of the alerts to return. Omit to return all alerts in all statuses. + - description: Status of the alerts to return. Omit this parameter to return all alerts in all statuses. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. in: query name: status schema: @@ -41619,6 +41612,9 @@ paths: tags: - Alerts x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeAlert + x-xgen-method-verb-override: + customMethod: "True" + verb: acknowledge /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs: get: description: |- @@ -41772,6 +41768,9 @@ paths: tags: - Programmatic API Keys x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/removeProjectApiKey + x-xgen-method-verb-override: + customMethod: "True" + verb: remove patch: description: Updates the roles of the organization API key that you specify for the project that you specify. You must specify at least one valid role for the project. The application removes any roles that you do not include in this request if they were previously set in the organization API key that you specify for the project. operationId: updateApiKeyRoles @@ -41818,6 +41817,9 @@ paths: tags: - Programmatic API Keys x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKeyRoles + x-xgen-method-verb-override: + customMethod: "True" + verb: updateRoles post: description: Assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. operationId: addProjectApiKey @@ -41859,6 +41861,9 @@ paths: tags: - Programmatic API Keys x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addProjectApiKey + x-xgen-method-verb-override: + customMethod: "True" + verb: add /api/atlas/v2/groups/{groupId}/auditLog: get: description: Returns the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. @@ -41989,6 +41994,9 @@ paths: tags: - AWS Clusters DNS x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/toggleAwsCustomDns + x-xgen-method-verb-override: + customMethod: "True" + verb: toggle /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: description: Returns all Export Buckets associated with the specified Project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -42086,6 +42094,7 @@ paths: links: - href: https://cloud.mongodb.com/api/atlas rel: self + region: us-east-1 schema: $ref: '#/components/schemas/DiskBackupSnapshotAWSExportBucketResponse' x-sunset: "2026-05-30" @@ -42102,6 +42111,7 @@ paths: links: - href: https://cloud.mongodb.com/api/atlas rel: self + region: us-east-1 Azure: description: Azure value: @@ -42206,6 +42216,7 @@ paths: links: - href: https://cloud.mongodb.com/api/atlas rel: self + region: us-east-1 schema: $ref: '#/components/schemas/DiskBackupSnapshotAWSExportBucketResponse' x-sunset: "2026-05-30" @@ -42222,6 +42233,7 @@ paths: links: - href: https://cloud.mongodb.com/api/atlas rel: self + region: us-east-1 Azure: description: Azure value: @@ -42288,6 +42300,9 @@ paths: tags: - Cloud Backups x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/disableDataProtectionSettings + x-xgen-method-verb-override: + customMethod: "True" + verb: disable x-xgen-atlascli: watcher: get: @@ -42433,7 +42448,7 @@ paths: - Cloud Provider Access x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/listCloudProviderAccessRoles post: - description: Creates one access role for the specified cloud provider. Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + description: Creates one access role for the specified cloud provider. Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting Service Account or API Key must have the Project Owner role. For the GCP provider, if the project folder is not yet provisioned, Atlas will now create the role asynchronously. An intermediate role with status `IN_PROGRESS` will be returned, and the final service account will be provisioned. Once the GCP project is set up, subsequent requests will create the service account synchronously. externalDocs: description: Set Up Access to Cloud Providers url: https://www.mongodb.com/docs/atlas/security/cloud-provider-access/ @@ -42514,6 +42529,9 @@ paths: tags: - Cloud Provider Access x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/deauthorizeCloudProviderAccessRole + x-xgen-method-verb-override: + customMethod: "True" + verb: deauthorizeRole /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}: get: description: Returns the access role with the specified id and with access to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -42599,6 +42617,9 @@ paths: tags: - Cloud Provider Access x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/authorizeCloudProviderAccessRole + x-xgen-method-verb-override: + customMethod: "True" + verb: authorizeRole /api/atlas/v2/groups/{groupId}/clusters: get: description: |- @@ -43305,6 +43326,9 @@ paths: tags: - Collection Level Metrics x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForCluster + x-xgen-method-verb-override: + customMethod: "False" + verb: get /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration: get: deprecated: true @@ -43345,6 +43369,8 @@ paths: tags: - Clusters x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/autoScalingConfiguration + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: description: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. @@ -43615,6 +43641,9 @@ paths: tags: - Cloud Backups x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelBackupRestoreJob + x-xgen-method-verb-override: + customMethod: "True" + verb: cancel get: description: Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. operationId: getBackupRestoreJob @@ -43736,6 +43765,9 @@ paths: tags: - Cloud Backups x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupSchedule + x-xgen-method-verb-override: + customMethod: "False" + verb: get patch: description: Updates the cloud backup schedule for one cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Owner role. operationId: updateBackupSchedule @@ -43876,6 +43908,9 @@ paths: tags: - Cloud Backups x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/takeSnapshot + x-xgen-method-verb-override: + customMethod: "True" + verb: take x-xgen-atlascli: watcher: get: @@ -44233,6 +44268,8 @@ paths: tags: - Shared-Tier Snapshots x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/downloadSharedClusterBackup + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore: post: deprecated: true @@ -44603,6 +44640,9 @@ paths: tags: - Collection Level Metrics x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getPinnedNamespaces + x-xgen-method-verb-override: + customMethod: "True" + verb: listNamespaces patch: description: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. operationId: pinNamespacesPatch @@ -44652,6 +44692,9 @@ paths: tags: - Collection Level Metrics x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPatch + x-xgen-method-verb-override: + customMethod: "True" + verb: updateNamespaces x-xgen-atlascli: override: description: | @@ -44705,6 +44748,9 @@ paths: tags: - Collection Level Metrics x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPut + x-xgen-method-verb-override: + customMethod: "True" + verb: pinNamespaces /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin: patch: description: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. @@ -44748,6 +44794,9 @@ paths: tags: - Collection Level Metrics x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/unpinNamespaces + x-xgen-method-verb-override: + customMethod: "True" + verb: unpinNamespaces /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes: post: deprecated: true @@ -45764,6 +45813,9 @@ paths: tags: - Online Archive x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadOnlineArchiveQueryLogs + x-xgen-method-verb-override: + customMethod: "True" + verb: download /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation: delete: description: Ends a cluster outage simulation. @@ -45804,6 +45856,9 @@ paths: tags: - Cluster Outage Simulation x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/endOutageSimulation + x-xgen-method-verb-override: + customMethod: "True" + verb: end x-xgen-atlascli: watcher: get: @@ -45857,6 +45912,9 @@ paths: tags: - Cluster Outage Simulation x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/getOutageSimulation + x-xgen-method-verb-override: + customMethod: "False" + verb: get post: description: Starts a cluster outage simulation. externalDocs: @@ -45903,6 +45961,9 @@ paths: tags: - Cluster Outage Simulation x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/startOutageSimulation + x-xgen-method-verb-override: + customMethod: "True" + verb: start x-xgen-atlascli: watcher: get: @@ -46437,6 +46498,8 @@ paths: tags: - Clusters x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/testFailover + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs: get: deprecated: true @@ -46692,6 +46755,9 @@ paths: x-xgen-changelog: "2025-03-12": Updates the return of the API when no nodes exist, the endpoint returns 200 with an empty JSON ({}) instead of 400. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchDeployment + x-xgen-method-verb-override: + customMethod: "False" + verb: get patch: description: Updates the Search Nodes for the specified cluster. operationId: updateAtlasSearchDeployment @@ -47100,6 +47166,9 @@ paths: tags: - Atlas Search x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexByName + x-xgen-method-verb-override: + customMethod: "True" + verb: getByName x-xgen-atlascli: override: description: | @@ -47170,6 +47239,9 @@ paths: tags: - Atlas Search x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexByName + x-xgen-method-verb-override: + customMethod: "True" + verb: updateByName /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}: delete: description: Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. @@ -47915,6 +47987,9 @@ paths: tags: - Monitoring and Logs x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostLogs + x-xgen-method-verb-override: + customMethod: "True" + verb: download requestBody: content: application/vnd.atlas.2023-02-01+gzip: @@ -48010,6 +48085,9 @@ paths: tags: - Clusters x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedCluster + x-xgen-method-verb-override: + customMethod: "True" + verb: upgrade /api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless: post: deprecated: true @@ -48059,6 +48137,9 @@ paths: tags: - Clusters x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedClusterToServerless + x-xgen-method-verb-override: + customMethod: "True" + verb: upgrade /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. @@ -48320,6 +48401,9 @@ paths: tags: - Network Peering x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainers + x-xgen-method-verb-override: + customMethod: "False" + verb: list /api/atlas/v2/groups/{groupId}/customDBRoles/roles: get: description: Returns all custom roles for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -48915,6 +48999,9 @@ paths: tags: - Data Federation x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createOneDataFederationQueryLimit + x-xgen-method-verb-override: + customMethod: "True" + verb: set /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz: get: description: 'Downloads the query logs for the specified federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -48969,6 +49056,9 @@ paths: tags: - Data Federation x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadFederatedDatabaseQueryLogs + x-xgen-method-verb-override: + customMethod: "True" + verb: download /api/atlas/v2/groups/{groupId}/databaseUsers: get: description: Returns all database users that belong to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -49759,6 +49849,9 @@ paths: tags: - Encryption at Rest using Customer Key Management x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/requestEncryptionAtRestPrivateEndpointDeletion + x-xgen-method-verb-override: + customMethod: "True" + verb: requestDeletion get: description: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. operationId: getEncryptionAtRestPrivateEndpoint @@ -50224,6 +50317,8 @@ paths: tags: - Flex Snapshots x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs: get: description: Returns all restore jobs for one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -51488,6 +51583,9 @@ paths: tags: - Projects x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/setProjectLimit + x-xgen-method-verb-override: + customMethod: "True" + verb: set /api/atlas/v2/groups/{groupId}/liveMigrations: post: description: |- @@ -51603,6 +51701,8 @@ paths: tags: - Cloud Migration Service x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/cutoverMigration + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/liveMigrations/validate: post: description: Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. If the check passes, the migration can proceed. Your API Key must have the Organization Owner role to successfully call this resource. @@ -51650,6 +51750,8 @@ paths: tags: - Cloud Migration Service x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateMigration + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}: get: description: Return the status of one migration validation job. Your API Key must have the Organization Owner role to successfully call this resource. @@ -51687,6 +51789,9 @@ paths: tags: - Cloud Migration Service x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getValidationStatus + x-xgen-method-verb-override: + customMethod: "True" + verb: getStatus /api/atlas/v2/groups/{groupId}/maintenanceWindow: delete: description: Resets the maintenance window for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -51714,6 +51819,9 @@ paths: tags: - Maintenance Windows x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/resetMaintenanceWindow + x-xgen-method-verb-override: + customMethod: "True" + verb: reset get: description: Returns the maintenance window for the specified project. MongoDB Cloud starts those maintenance activities when needed. You can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. operationId: getMaintenanceWindow @@ -51803,6 +51911,9 @@ paths: tags: - Maintenance Windows x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/toggleMaintenanceAutoDefer + x-xgen-method-verb-override: + customMethod: "True" + verb: toggle /api/atlas/v2/groups/{groupId}/maintenanceWindow/defer: post: description: Defers the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -51830,6 +51941,8 @@ paths: tags: - Maintenance Windows x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/deferMaintenanceWindow + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/managedSlowMs: get: description: Get whether the Managed Slow MS feature is enabled. @@ -51890,6 +52003,8 @@ paths: tags: - Performance Advisor x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/disableSlowOperationThresholding + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/managedSlowMs/enable: post: description: Enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -51918,6 +52033,8 @@ paths: tags: - Performance Advisor x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/enableSlowOperationThresholding + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/mongoDBVersions: get: description: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. @@ -52563,6 +52680,8 @@ paths: tags: - Data Lake Pipelines x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/pausePipeline + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: deprecated: true @@ -52602,6 +52721,8 @@ paths: tags: - Data Lake Pipelines x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/resumePipeline + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: deprecated: true @@ -52793,6 +52914,8 @@ paths: tags: - Data Lake Pipelines x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/triggerSnapshotIngestion + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService: get: description: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -53211,6 +53334,9 @@ paths: tags: - Private Endpoint Services x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getRegionalizedPrivateEndpointSetting + x-xgen-method-verb-override: + customMethod: "False" + verb: get patch: description: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. The cloud service provider manages the private endpoints for the project. Connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime. To use this resource, the requesting Service Account or API Key must have the Project Owner role and all clusters in the deployment must be sharded clusters. Once enabled, you cannot create replica sets. operationId: toggleRegionalizedPrivateEndpointSetting @@ -53247,6 +53373,9 @@ paths: tags: - Private Endpoint Services x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/toggleRegionalizedPrivateEndpointSetting + x-xgen-method-verb-override: + customMethod: "True" + verb: toggle /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint: get: description: |- @@ -53521,6 +53650,9 @@ paths: tags: - Network Peering x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/verifyConnectViaPeeringOnlyModeForOneProject + x-xgen-method-verb-override: + customMethod: "True" + verb: verify patch: deprecated: true description: Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -53561,6 +53693,9 @@ paths: tags: - Network Peering x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/disablePeering + x-xgen-method-verb-override: + customMethod: "True" + verb: disablePeering /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds: get: description: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. @@ -53898,6 +54033,9 @@ paths: tags: - Collection Level Metrics x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForHost + x-xgen-method-verb-override: + customMethod: "False" + verb: get /api/atlas/v2/groups/{groupId}/processes/{processId}/databases: get: description: Returns the list of databases running on the specified host for the specified project. `M0` free clusters, `M2`, `M5`, serverless, and Flex clusters have some operational limits. The MongoDB Cloud process must be a `mongod`. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -54724,6 +54862,9 @@ paths: tags: - Push-Based Log Export x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/getPushBasedLogConfiguration + x-xgen-method-verb-override: + customMethod: "False" + verb: get patch: description: Updates the project level settings for the push-based log export feature. operationId: updatePushBasedLogConfiguration @@ -54832,6 +54973,9 @@ paths: tags: - Clusters x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/loadSampleDataset + x-xgen-method-verb-override: + customMethod: "True" + verb: request x-xgen-atlascli: watcher: get: @@ -55267,6 +55411,9 @@ paths: tags: - Performance Advisor x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getServerlessAutoIndexing + x-xgen-method-verb-override: + customMethod: "False" + verb: get post: description: Set whether the Serverless Auto Indexing feature is enabled. This endpoint sets a value for Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026. externalDocs: @@ -55309,6 +55456,9 @@ paths: tags: - Performance Advisor x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/setServerlessAutoIndexing + x-xgen-method-verb-override: + customMethod: "True" + verb: set /api/atlas/v2/groups/{groupId}/serverless/{name}: delete: description: |- @@ -56232,6 +56382,9 @@ paths: tags: - Streams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/downloadStreamTenantAuditLogs + x-xgen-method-verb-override: + customMethod: "True" + verb: download /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections: get: description: Returns all connections of the stream instance for the specified project.To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. @@ -56832,6 +56985,9 @@ paths: tags: - Streams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getAccountDetails + x-xgen-method-verb-override: + customMethod: "False" + verb: get /api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections: get: description: Returns a list of active incoming VPC Peering Connections. @@ -57175,151 +57331,6 @@ paths: tags: - Streams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstanceWithSampleConnections - /api/atlas/v2/groups/{groupId}/streamsTgwRoutes: - get: - description: List Transit Gateway routes in the default route table associated with Atlas VPC. - operationId: listTransitGatewayRoutes - parameters: - - $ref: '#/components/parameters/groupId' - - $ref: '#/components/parameters/envelope' - - $ref: '#/components/parameters/itemsPerPage' - - $ref: '#/components/parameters/pageNum' - responses: - "200": - content: - application/vnd.atlas.preview+json: - schema: - $ref: '#/components/schemas/PaginatedApiStreamsTransitGatewayRouteResponse' - x-xgen-preview: - name: aws-transit-gateway - x-xgen-version: preview - 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' - summary: Return All Transit Gateway Routes in the Default Route Table for One Atlas VPC - tags: - - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listTransitGatewayRoutes - post: - description: Creates a route in the default route table associated with Atlas VPC to route all traffic destined for provided CIDR to the provided Transit Gateway. - operationId: createTransitGatewayRoute - parameters: - - $ref: '#/components/parameters/groupId' - - $ref: '#/components/parameters/envelope' - requestBody: - content: - application/vnd.atlas.preview+json: - schema: - $ref: '#/components/schemas/StreamsTransitGatewayRouteRequest' - description: Metadata needed for creating a transit gateway route. - required: true - responses: - "201": - content: - application/vnd.atlas.preview+json: - schema: - $ref: '#/components/schemas/StreamsTransitGatewayRouteResponse' - x-xgen-preview: - name: aws-transit-gateway - x-xgen-version: preview - description: Created - "400": - $ref: '#/components/responses/badRequest' - "401": - $ref: '#/components/responses/unauthorized' - "403": - $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/notFound' - "500": - $ref: '#/components/responses/internalServerError' - summary: Creates a route in the default route table associated with Atlas VPC to route all traffic destined for provided CIDR to the provided Transit Gateway. - tags: - - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createTransitGatewayRoute - /api/atlas/v2/groups/{groupId}/streamsTgwRoutes/{routeId}: - delete: - description: Deletes a transit gateway route in the default route table associated with Atlas VPC. - operationId: deleteTransitGatewayRoute - parameters: - - $ref: '#/components/parameters/groupId' - - $ref: '#/components/parameters/envelope' - - description: The Object ID that uniquely identifies a transit gateway route. - in: path - name: routeId - required: true - schema: - example: 32b6e34b3d91647abb20e7b8 - pattern: ^([a-f0-9]{24})$ - type: string - responses: - "204": - content: - application/vnd.atlas.preview+json: - x-xgen-preview: - name: aws-transit-gateway - x-xgen-version: preview - description: No Content - "400": - $ref: '#/components/responses/badRequest' - "401": - $ref: '#/components/responses/unauthorized' - "403": - $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/notFound' - "500": - $ref: '#/components/responses/internalServerError' - summary: Delete One Transit Gateway Route in the Default Route Table for One Atlas VPC - tags: - - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteTransitGatewayRoute - get: - description: Retrieves a transit gateway route in the default route table associated with Atlas VPC. - operationId: getTransitGatewayRoute - parameters: - - $ref: '#/components/parameters/groupId' - - description: The Object ID that uniquely identifies a transit gateway route. - in: path - name: routeId - required: true - schema: - example: 32b6e34b3d91647abb20e7b8 - pattern: ^([a-f0-9]{24})$ - type: string - - $ref: '#/components/parameters/envelope' - responses: - "200": - content: - application/vnd.atlas.preview+json: - schema: - $ref: '#/components/schemas/StreamsTransitGatewayRouteResponse' - x-xgen-preview: - name: aws-transit-gateway - x-xgen-version: preview - 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' - summary: Return One Transit Gateway Route in the Default Route Table for One Atlas VPC - tags: - - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getTransitGatewayRoute /api/atlas/v2/groups/{groupId}/teams: get: description: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -57394,6 +57405,9 @@ paths: tags: - Teams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addAllTeamsToProject + x-xgen-method-verb-override: + customMethod: "True" + verb: add x-xgen-atlascli: override: description: | @@ -57435,6 +57449,9 @@ paths: tags: - Teams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeProjectTeam + x-xgen-method-verb-override: + customMethod: "True" + verb: remove get: description: Returns one team to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. operationId: getProjectTeam @@ -57621,6 +57638,9 @@ paths: tags: - X.509 Authentication x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/disableCustomerManagedX509 + x-xgen-method-verb-override: + customMethod: "True" + verb: disable /api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping: delete: description: Removes the current LDAP Distinguished Name mapping captured in the ``userToDNMapping`` document from the LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -57686,6 +57706,8 @@ paths: tags: - LDAP Configuration x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/verifyLdapConfiguration + x-xgen-method-verb-override: + customMethod: "True" x-xgen-atlascli: watcher: get: @@ -57735,6 +57757,9 @@ paths: tags: - LDAP Configuration x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfigurationStatus + x-xgen-method-verb-override: + customMethod: "False" + verb: get /api/atlas/v2/groups/{groupId}/users: get: description: |- @@ -57841,6 +57866,9 @@ paths: tags: - MongoDB Cloud Users x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectUser + x-xgen-method-verb-override: + customMethod: "True" + verb: add /api/atlas/v2/groups/{groupId}/users/{userId}: delete: description: |- @@ -57889,6 +57917,9 @@ paths: tags: - MongoDB Cloud Users x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectUser + x-xgen-method-verb-override: + customMethod: "True" + verb: remove get: description: |- Returns information about the specified MongoDB Cloud user within the context of the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -58007,7 +58038,7 @@ paths: content: application/vnd.atlas.2025-02-19+json: schema: - $ref: '#/components/schemas/OrgUserResponse' + $ref: '#/components/schemas/GroupUserResponse' x-xgen-version: "2025-02-19" description: OK "400": @@ -58059,7 +58090,7 @@ paths: content: application/vnd.atlas.2025-02-19+json: schema: - $ref: '#/components/schemas/OrgUserResponse' + $ref: '#/components/schemas/GroupUserResponse' x-xgen-version: "2025-02-19" description: OK "400": @@ -58672,6 +58703,9 @@ paths: tags: - Programmatic API Keys x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKeyAccessListEntry + x-xgen-method-verb-override: + customMethod: "True" + verb: deleteEntry get: description: Returns one access list entry for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Organization Member role. externalDocs: @@ -60280,6 +60314,9 @@ paths: tags: - Service Accounts x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountAccessListEntry + x-xgen-method-verb-override: + customMethod: "True" + verb: deleteEntry /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups: get: description: Returns a list of all projects the specified Service Account is a part of. @@ -60676,6 +60713,9 @@ paths: tags: - Teams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/renameTeam + x-xgen-method-verb-override: + customMethod: "True" + verb: rename /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users: get: description: |- @@ -60713,6 +60753,12 @@ paths: schema: example: ACTIVE type: string + - description: Unique 24-hexadecimal digit string to filter users by. Not supported in deprecated versions. + in: query + name: userId + schema: + pattern: ^([a-f0-9]{24})$ + type: string responses: "200": content: @@ -60797,6 +60843,9 @@ paths: tags: - Teams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addTeamUser + x-xgen-method-verb-override: + customMethod: "True" + verb: add /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}: delete: deprecated: true @@ -60847,6 +60896,9 @@ paths: tags: - Teams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeTeamUser + x-xgen-method-verb-override: + customMethod: "True" + verb: remove /api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser: post: description: |- @@ -61133,6 +61185,9 @@ paths: tags: - MongoDB Cloud Users x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationUser + x-xgen-method-verb-override: + customMethod: "True" + verb: remove get: description: |- Returns information about the specified MongoDB Cloud user within the context of the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Member role. @@ -61612,7 +61667,7 @@ tags: 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. + - description: Creates one index to a database deployment in a rolling manner. Rolling indexes build indexes on the applicable nodes sequentially and may reduce the performance impact of an index build if your deployment's average CPU utilization exceeds (N-1)/N-10% where N is the number of CPU threads available to mongod of if the WiredTiger cache fill ratio regularly exceeds 90%. If your deployment does not meet this criteria, use the default index build. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster. name: Rolling Index - description: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API. name: Root diff --git a/tools/internal/specs/spec.yaml b/tools/internal/specs/spec.yaml index 23cdb0d3df..c5a5a8e021 100644 --- a/tools/internal/specs/spec.yaml +++ b/tools/internal/specs/spec.yaml @@ -1774,7 +1774,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -2186,6 +2186,7 @@ components: ) when { context.cluster.regions.contains(cloud::region::"aws:us-east-1") }; + minLength: 1 type: string required: - body @@ -3272,7 +3273,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -6435,6 +6436,7 @@ components: - AWS_USAGE_REPORTED - AZURE_USAGE_REPORTED - GCP_USAGE_REPORTED + - VERCEL_USAGE_REPORTED - BECAME_PAYING_ORG - NEW_LINKED_ORG - UNLINKED_ORG @@ -8027,6 +8029,15 @@ components: pattern: ^([a-f0-9]{24})$ readOnly: true type: string + status: + description: Provision status of the service account. + enum: + - IN_PROGRESS + - COMPLETE + - FAILED + - NOT_INITIATED + readOnly: true + type: string type: object description: Details that describe the features linked to the GCP Service Account. required: @@ -8155,6 +8166,11 @@ components: items: $ref: '#/components/schemas/CloudProviderAccessAzureServicePrincipal' type: array + gcpServiceAccounts: + description: List that contains the Google Service Accounts registered and authorized with MongoDB Cloud. + items: + $ref: '#/components/schemas/CloudProviderAccessGCPServiceAccount' + type: array type: object CloudProviderAzureAutoScaling: description: Range of instance sizes to which your cluster can scale. @@ -8818,7 +8834,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -12197,7 +12213,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -13459,7 +13475,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -13537,6 +13553,7 @@ components: - CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS - CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES - CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID + - CLUSTER_CONNECTION_GET_AGGREGATED_VIEW_INFOS - CLUSTER_CONNECTION_AGGREGATE - CLUSTER_CONNECTION_CREATE_COLLECTION - CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES @@ -14153,6 +14170,7 @@ components: properties: clusterName: description: Label that identifies the destination cluster. + minLength: 1 type: string groupId: description: Unique 24-hexadecimal digit string that identifies the destination project. @@ -14165,6 +14183,7 @@ components: - PUBLIC - PRIVATE_LINK - VPC_PEERING + minLength: 1 type: string privateLinkId: description: Represents the endpoint to use when the host schema type is `PRIVATE_LINK`. @@ -14900,6 +14919,11 @@ components: $ref: '#/components/schemas/Link' readOnly: true type: array + region: + description: AWS region for the export bucket. This is set by Atlas and is never user-supplied. + example: us-east-1 + readOnly: true + type: string required: - _id - bucketName @@ -16410,6 +16434,7 @@ components: - CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS - CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES - CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID + - CLUSTER_CONNECTION_GET_AGGREGATED_VIEW_INFOS - CLUSTER_CONNECTION_AGGREGATE - CLUSTER_CONNECTION_CREATE_COLLECTION - CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES @@ -16568,6 +16593,8 @@ components: - HOST_MONGOT_CRASHING_OOM - HOST_MONGOT_RESUME_REPLICATION - HOST_MONGOT_STOP_REPLICATION + - HOST_MONGOT_SUFFICIENT_DISK_SPACE + - HOST_MONGOT_APPROACHING_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE - SSH_KEY_NDS_HOST_ACCESS_REQUESTED @@ -16685,6 +16712,7 @@ components: - ATLAS_MAINTENANCE_DEFERRED - ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED - ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED + - ATLAS_MAINTENANCE_RESET_BY_ADMIN - SCHEDULED_MAINTENANCE - PROJECT_SCHEDULED_MAINTENANCE - PROJECT_LIMIT_UPDATED @@ -16751,8 +16779,6 @@ components: - AUTO_HEALING_REQUESTED_CRITICAL_INSTANCE_POWER_CYCLE - AUTO_HEALING_REQUESTED_INSTANCE_REPLACEMENT - AUTO_HEALING_REQUESTED_NODE_RESYNC - - AUTO_HEALING_CANNOT_REPAIR_INTERNAL - - AUTO_HEALING_CANNOT_RESYNC_INTERNAL - EXTRA_MAINTENANCE_DEFERRAL_GRANTED - ADMIN_NOTE_UPDATED - GROUP_AUTOMATION_CONFIG_PUBLISHED @@ -16830,8 +16856,6 @@ components: - CLUSTER_IP_ROLLED_BACK - AZ_BALANCING_OVERRIDE_MODIFIED - FTDC_SETTINGS_UPDATED - - MONGOTUNE_ENABLED - - MONGOTUNE_DISABLED - PROXY_PROTOCOL_FOR_PRIVATE_LINK_MODE_UPDATED title: NDS Audit Types type: string @@ -17157,6 +17181,7 @@ components: - AWS_USAGE_REPORTED - AZURE_USAGE_REPORTED - GCP_USAGE_REPORTED + - VERCEL_USAGE_REPORTED - BECAME_PAYING_ORG - NEW_LINKED_ORG - UNLINKED_ORG @@ -20906,6 +20931,7 @@ components: - GROUP_OBSERVABILITY_VIEWER - GROUP_DATABASE_ACCESS_ADMIN type: string + minItems: 1 type: array secretExpiresAfterHours: description: The expiration time of the new Service Account secret, provided in hours. The minimum and maximum allowed expiration times are subject to change and are controlled by the organization's settings. @@ -20937,6 +20963,7 @@ components: - GROUP_OBSERVABILITY_VIEWER - GROUP_DATABASE_ACCESS_ADMIN type: string + minItems: 1 type: array uniqueItems: true required: @@ -21341,7 +21368,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -21380,6 +21407,8 @@ components: - HOST_MONGOT_CRASHING_OOM - HOST_MONGOT_RESUME_REPLICATION - HOST_MONGOT_STOP_REPLICATION + - HOST_MONGOT_SUFFICIENT_DISK_SPACE + - HOST_MONGOT_APPROACHING_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE - SSH_KEY_NDS_HOST_ACCESS_REQUESTED @@ -21406,6 +21435,7 @@ components: - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_CRASHING_OOM - HOST_MONGOT_STOP_REPLICATION + - HOST_MONGOT_APPROACHING_STOP_REPLICATION - HOST_NOT_ENOUGH_DISK_SPACE - SSH_KEY_NDS_HOST_ACCESS_REQUESTED - SSH_KEY_NDS_HOST_ACCESS_REFRESHED @@ -21841,7 +21871,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -24701,6 +24731,7 @@ components: description: List of migration hosts used for this migration. items: example: vm001.example.com + minLength: 1 type: string maxItems: 1 minItems: 1 @@ -26435,6 +26466,7 @@ components: - ATLAS_MAINTENANCE_DEFERRED - ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED - ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED + - ATLAS_MAINTENANCE_RESET_BY_ADMIN - SCHEDULED_MAINTENANCE - PROJECT_SCHEDULED_MAINTENANCE - PROJECT_LIMIT_UPDATED @@ -26501,8 +26533,6 @@ components: - AUTO_HEALING_REQUESTED_CRITICAL_INSTANCE_POWER_CYCLE - AUTO_HEALING_REQUESTED_INSTANCE_REPLACEMENT - AUTO_HEALING_REQUESTED_NODE_RESYNC - - AUTO_HEALING_CANNOT_REPAIR_INTERNAL - - AUTO_HEALING_CANNOT_RESYNC_INTERNAL - EXTRA_MAINTENANCE_DEFERRAL_GRANTED - ADMIN_NOTE_UPDATED - GROUP_AUTOMATION_CONFIG_PUBLISHED @@ -26580,8 +26610,6 @@ components: - CLUSTER_IP_ROLLED_BACK - AZ_BALANCING_OVERRIDE_MODIFIED - FTDC_SETTINGS_UPDATED - - MONGOTUNE_ENABLED - - MONGOTUNE_DISABLED - PROXY_PROTOCOL_FOR_PRIVATE_LINK_MODE_UPDATED example: CLUSTER_CREATED title: NDS Audit Types @@ -27602,7 +27630,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -28853,6 +28881,7 @@ components: - ORG_GROUP_CREATOR - ORG_OWNER type: string + minItems: 1 type: array secretExpiresAfterHours: description: The expiration time of the new Service Account secret, provided in hours. The minimum and maximum allowed expiration times are subject to change and are controlled by the organization's settings. @@ -29830,30 +29859,6 @@ components: readOnly: true type: integer type: object - PaginatedApiStreamsTransitGatewayRouteResponse: - properties: - links: - description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: '#/components/schemas/Link' - readOnly: true - type: array - results: - description: List of returned documents that MongoDB Cloud provides when completing this request. - items: - $ref: '#/components/schemas/StreamsTransitGatewayRouteResponse' - readOnly: true - type: array - totalCount: - description: Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact. - format: int32 - minimum: 0 - readOnly: true - type: integer - type: object PaginatedApiUserAccessListResponseView: properties: links: @@ -31468,6 +31473,10 @@ components: description: Password needed to allow MongoDB Cloud to access your Prometheus account. type: string writeOnly: true + sendUserProvidedResourceTagsEnabled: + default: false + description: Toggle sending user provided group and cluster resource tags with the prometheus metrics. + type: boolean serviceDiscovery: description: Desired method to discover the Prometheus service. enum: @@ -31952,7 +31961,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -32343,7 +32352,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -35354,6 +35363,7 @@ components: type: string clusterName: description: Label that identifies the source cluster name. + minLength: 1 type: string groupId: description: Unique 24-hexadecimal digit string that identifies the source project. @@ -35580,7 +35590,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -36559,38 +36569,6 @@ components: streamConfig: $ref: '#/components/schemas/StreamConfig' type: object - StreamsTransitGatewayRouteRequest: - description: Container for metadata needed to create a Transit Gateway route. - properties: - destinationCidr: - description: The route's destination CIDR. - type: string - region: - description: The region of the Atlas VPCs where this route should take effect. - type: string - tgwId: - description: The AWS ID of the Transit Gateway through which traffic will be routed. - type: string - type: object - StreamsTransitGatewayRouteResponse: - description: Container for metadata associated with a Transit Gateway route. - properties: - destinationCidr: - description: The route's destination CIDR. - type: string - region: - description: The region of the Atlas VPCs where this route should take effect. - type: string - tgwId: - description: The AWS ID of the Transit Gateway through which traffic will be routed. - type: string - tgwRouteId: - description: The ID of the Transit Gateway route. - example: 32b6e34b3d91647abb20e7b8 - pattern: ^([a-f0-9]{24})$ - readOnly: true - type: string - type: object SwapUsageFreeDataMetricThresholdView: properties: metricName: @@ -37856,7 +37834,7 @@ components: readOnly: true type: string status: - description: State of this alert at the time you requested its details. + description: State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. enum: - CANCELLED - CLOSED @@ -39872,7 +39850,7 @@ info: termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions title: MongoDB Atlas Administration API version: "2.0" - x-xgen-sha: 8603db49332d5c974f57f05e4a4b43dad0697914 + x-xgen-sha: 53e2fb6c08b2e2450803352c94465369d16a6e64 openapi: 3.0.1 paths: /api/atlas/v2: @@ -40081,6 +40059,9 @@ paths: tags: - Federated Authentication x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/removeConnectedOrgConfig + x-xgen-method-verb-override: + customMethod: "True" + verb: remove get: description: Returns the specified connected org config from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. operationId: getConnectedOrgConfig @@ -40611,6 +40592,9 @@ paths: tags: - Federated Authentication x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/revokeJwksFromIdentityProvider + x-xgen-method-verb-override: + customMethod: "True" + verb: revoke /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml: get: description: Returns the metadata of one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. @@ -40640,6 +40624,9 @@ paths: tags: - Federated Authentication x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProviderMetadata + x-xgen-method-verb-override: + customMethod: "False" + verb: get /api/atlas/v2/groups: get: description: Returns details about all projects. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Organization Read Only role or higher. @@ -40855,6 +40842,9 @@ paths: tags: - Projects x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/addUserToProject + x-xgen-method-verb-override: + customMethod: "True" + verb: addUser /api/atlas/v2/groups/{groupId}/accessList: get: description: Returns all access list entries from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. @@ -41263,6 +41253,9 @@ paths: tags: - Alert Configurations x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration + x-xgen-method-verb-override: + customMethod: "True" + verb: toggle put: description: |- Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. @@ -41377,7 +41370,7 @@ paths: - $ref: '#/components/parameters/itemsPerPage' - $ref: '#/components/parameters/pageNum' - $ref: '#/components/parameters/pretty' - - description: Status of the alerts to return. Omit to return all alerts in all statuses. + - description: Status of the alerts to return. Omit this parameter to return all alerts in all statuses. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved. in: query name: status schema: @@ -41508,6 +41501,9 @@ paths: tags: - Alerts x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeAlert + x-xgen-method-verb-override: + customMethod: "True" + verb: acknowledge /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs: get: description: |- @@ -41661,6 +41657,9 @@ paths: tags: - Programmatic API Keys x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/removeProjectApiKey + x-xgen-method-verb-override: + customMethod: "True" + verb: remove patch: description: Updates the roles of the organization API key that you specify for the project that you specify. You must specify at least one valid role for the project. The application removes any roles that you do not include in this request if they were previously set in the organization API key that you specify for the project. operationId: updateApiKeyRoles @@ -41707,6 +41706,9 @@ paths: tags: - Programmatic API Keys x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKeyRoles + x-xgen-method-verb-override: + customMethod: "True" + verb: updateRoles post: description: Assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. operationId: addProjectApiKey @@ -41748,6 +41750,9 @@ paths: tags: - Programmatic API Keys x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addProjectApiKey + x-xgen-method-verb-override: + customMethod: "True" + verb: add /api/atlas/v2/groups/{groupId}/auditLog: get: description: Returns the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. @@ -41878,6 +41883,9 @@ paths: tags: - AWS Clusters DNS x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/toggleAwsCustomDns + x-xgen-method-verb-override: + customMethod: "True" + verb: toggle /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: description: Returns all Export Buckets associated with the specified Project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -41975,6 +41983,7 @@ paths: links: - href: https://cloud.mongodb.com/api/atlas rel: self + region: us-east-1 schema: $ref: '#/components/schemas/DiskBackupSnapshotAWSExportBucketResponse' x-sunset: "2026-05-30" @@ -41991,6 +42000,7 @@ paths: links: - href: https://cloud.mongodb.com/api/atlas rel: self + region: us-east-1 Azure: description: Azure value: @@ -42095,6 +42105,7 @@ paths: links: - href: https://cloud.mongodb.com/api/atlas rel: self + region: us-east-1 schema: $ref: '#/components/schemas/DiskBackupSnapshotAWSExportBucketResponse' x-sunset: "2026-05-30" @@ -42111,6 +42122,7 @@ paths: links: - href: https://cloud.mongodb.com/api/atlas rel: self + region: us-east-1 Azure: description: Azure value: @@ -42177,6 +42189,9 @@ paths: tags: - Cloud Backups x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/disableDataProtectionSettings + x-xgen-method-verb-override: + customMethod: "True" + verb: disable get: description: Returns the Backup Compliance Policy settings with the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. operationId: getDataProtectionSettings @@ -42298,7 +42313,7 @@ paths: - Cloud Provider Access x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/listCloudProviderAccessRoles post: - description: Creates one access role for the specified cloud provider. Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting Service Account or API Key must have the Project Owner role. + description: Creates one access role for the specified cloud provider. Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting Service Account or API Key must have the Project Owner role. For the GCP provider, if the project folder is not yet provisioned, Atlas will now create the role asynchronously. An intermediate role with status `IN_PROGRESS` will be returned, and the final service account will be provisioned. Once the GCP project is set up, subsequent requests will create the service account synchronously. externalDocs: description: Set Up Access to Cloud Providers url: https://www.mongodb.com/docs/atlas/security/cloud-provider-access/ @@ -42379,6 +42394,9 @@ paths: tags: - Cloud Provider Access x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/deauthorizeCloudProviderAccessRole + x-xgen-method-verb-override: + customMethod: "True" + verb: deauthorizeRole /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}: get: description: Returns the access role with the specified id and with access to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -42464,6 +42482,9 @@ paths: tags: - Cloud Provider Access x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/authorizeCloudProviderAccessRole + x-xgen-method-verb-override: + customMethod: "True" + verb: authorizeRole /api/atlas/v2/groups/{groupId}/clusters: get: description: |- @@ -43057,6 +43078,9 @@ paths: tags: - Collection Level Metrics x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForCluster + x-xgen-method-verb-override: + customMethod: "False" + verb: get /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration: get: deprecated: true @@ -43097,6 +43121,8 @@ paths: tags: - Clusters x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/autoScalingConfiguration + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: description: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. @@ -43351,6 +43377,9 @@ paths: tags: - Cloud Backups x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelBackupRestoreJob + x-xgen-method-verb-override: + customMethod: "True" + verb: cancel get: description: Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. operationId: getBackupRestoreJob @@ -43472,6 +43501,9 @@ paths: tags: - Cloud Backups x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupSchedule + x-xgen-method-verb-override: + customMethod: "False" + verb: get patch: description: Updates the cloud backup schedule for one cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Owner role. operationId: updateBackupSchedule @@ -43612,6 +43644,9 @@ paths: tags: - Cloud Backups x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/takeSnapshot + x-xgen-method-verb-override: + customMethod: "True" + verb: take /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}: delete: description: Removes the specified snapshot. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. @@ -43925,6 +43960,8 @@ paths: tags: - Shared-Tier Snapshots x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/downloadSharedClusterBackup + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore: post: deprecated: true @@ -44295,6 +44332,9 @@ paths: tags: - Collection Level Metrics x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getPinnedNamespaces + x-xgen-method-verb-override: + customMethod: "True" + verb: listNamespaces patch: description: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. operationId: pinNamespacesPatch @@ -44344,6 +44384,9 @@ paths: tags: - Collection Level Metrics x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPatch + x-xgen-method-verb-override: + customMethod: "True" + verb: updateNamespaces put: description: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. This initializes a pinned namespaces list or replaces any existing pinned namespaces list for the Group and Cluster. operationId: pinNamespacesPut @@ -44393,6 +44436,9 @@ paths: tags: - Collection Level Metrics x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPut + x-xgen-method-verb-override: + customMethod: "True" + verb: pinNamespaces /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin: patch: description: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. @@ -44436,6 +44482,9 @@ paths: tags: - Collection Level Metrics x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/unpinNamespaces + x-xgen-method-verb-override: + customMethod: "True" + verb: unpinNamespaces /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes: post: deprecated: true @@ -45405,6 +45454,9 @@ paths: tags: - Online Archive x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadOnlineArchiveQueryLogs + x-xgen-method-verb-override: + customMethod: "True" + verb: download /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation: delete: description: Ends a cluster outage simulation. @@ -45445,6 +45497,9 @@ paths: tags: - Cluster Outage Simulation x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/endOutageSimulation + x-xgen-method-verb-override: + customMethod: "True" + verb: end get: description: Returns one outage simulation for one cluster. externalDocs: @@ -45488,6 +45543,9 @@ paths: tags: - Cluster Outage Simulation x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/getOutageSimulation + x-xgen-method-verb-override: + customMethod: "False" + verb: get post: description: Starts a cluster outage simulation. externalDocs: @@ -45534,6 +45592,9 @@ paths: tags: - Cluster Outage Simulation x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/startOutageSimulation + x-xgen-method-verb-override: + customMethod: "True" + verb: start /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions: get: description: Returns the indexes that the Performance Advisor suggests to drop. The Performance Advisor suggests dropping unused, redundant, and hidden indexes to improve write performance and increase storage space. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -46055,6 +46116,8 @@ paths: tags: - Clusters x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/testFailover + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs: get: deprecated: true @@ -46300,6 +46363,9 @@ paths: x-xgen-changelog: "2025-03-12": Updates the return of the API when no nodes exist, the endpoint returns 200 with an empty JSON ({}) instead of 400. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchDeployment + x-xgen-method-verb-override: + customMethod: "False" + verb: get patch: description: Updates the Search Nodes for the specified cluster. operationId: updateAtlasSearchDeployment @@ -46682,6 +46748,9 @@ paths: tags: - Atlas Search x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexByName + x-xgen-method-verb-override: + customMethod: "True" + verb: getByName patch: description: Updates one Atlas Search index that you identified with its database, collection name, and index name. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. externalDocs: @@ -46748,6 +46817,9 @@ paths: tags: - Atlas Search x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexByName + x-xgen-method-verb-override: + customMethod: "True" + verb: updateByName /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}: delete: description: Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. @@ -47474,6 +47546,9 @@ paths: tags: - Monitoring and Logs x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostLogs + x-xgen-method-verb-override: + customMethod: "True" + verb: download /api/atlas/v2/groups/{groupId}/clusters/provider/regions: get: description: Returns the list of regions available for the specified cloud provider at the specified tier. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -47561,6 +47636,9 @@ paths: tags: - Clusters x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedCluster + x-xgen-method-verb-override: + customMethod: "True" + verb: upgrade /api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless: post: deprecated: true @@ -47610,6 +47688,9 @@ paths: tags: - Clusters x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedClusterToServerless + x-xgen-method-verb-override: + customMethod: "True" + verb: upgrade /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. @@ -47871,6 +47952,9 @@ paths: tags: - Network Peering x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainers + x-xgen-method-verb-override: + customMethod: "False" + verb: list /api/atlas/v2/groups/{groupId}/customDBRoles/roles: get: description: Returns all custom roles for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -48466,6 +48550,9 @@ paths: tags: - Data Federation x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createOneDataFederationQueryLimit + x-xgen-method-verb-override: + customMethod: "True" + verb: set /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz: get: description: 'Downloads the query logs for the specified federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -48520,6 +48607,9 @@ paths: tags: - Data Federation x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadFederatedDatabaseQueryLogs + x-xgen-method-verb-override: + customMethod: "True" + verb: download /api/atlas/v2/groups/{groupId}/databaseUsers: get: description: Returns all database users that belong to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -49310,6 +49400,9 @@ paths: tags: - Encryption at Rest using Customer Key Management x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/requestEncryptionAtRestPrivateEndpointDeletion + x-xgen-method-verb-override: + customMethod: "True" + verb: requestDeletion get: description: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. operationId: getEncryptionAtRestPrivateEndpoint @@ -49738,6 +49831,8 @@ paths: tags: - Flex Snapshots x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs: get: description: Returns all restore jobs for one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -50979,6 +51074,9 @@ paths: tags: - Projects x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/setProjectLimit + x-xgen-method-verb-override: + customMethod: "True" + verb: set /api/atlas/v2/groups/{groupId}/liveMigrations: post: description: |- @@ -51094,6 +51192,8 @@ paths: tags: - Cloud Migration Service x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/cutoverMigration + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/liveMigrations/validate: post: description: Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. If the check passes, the migration can proceed. Your API Key must have the Organization Owner role to successfully call this resource. @@ -51141,6 +51241,8 @@ paths: tags: - Cloud Migration Service x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateMigration + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}: get: description: Return the status of one migration validation job. Your API Key must have the Organization Owner role to successfully call this resource. @@ -51178,6 +51280,9 @@ paths: tags: - Cloud Migration Service x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getValidationStatus + x-xgen-method-verb-override: + customMethod: "True" + verb: getStatus /api/atlas/v2/groups/{groupId}/maintenanceWindow: delete: description: Resets the maintenance window for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -51205,6 +51310,9 @@ paths: tags: - Maintenance Windows x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/resetMaintenanceWindow + x-xgen-method-verb-override: + customMethod: "True" + verb: reset get: description: Returns the maintenance window for the specified project. MongoDB Cloud starts those maintenance activities when needed. You can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. operationId: getMaintenanceWindow @@ -51294,6 +51402,9 @@ paths: tags: - Maintenance Windows x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/toggleMaintenanceAutoDefer + x-xgen-method-verb-override: + customMethod: "True" + verb: toggle /api/atlas/v2/groups/{groupId}/maintenanceWindow/defer: post: description: Defers the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -51321,6 +51432,8 @@ paths: tags: - Maintenance Windows x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/deferMaintenanceWindow + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/managedSlowMs: get: description: Get whether the Managed Slow MS feature is enabled. @@ -51381,6 +51494,8 @@ paths: tags: - Performance Advisor x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/disableSlowOperationThresholding + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/managedSlowMs/enable: post: description: Enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -51409,6 +51524,8 @@ paths: tags: - Performance Advisor x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/enableSlowOperationThresholding + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/mongoDBVersions: get: description: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. @@ -52018,6 +52135,8 @@ paths: tags: - Data Lake Pipelines x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/pausePipeline + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: deprecated: true @@ -52057,6 +52176,8 @@ paths: tags: - Data Lake Pipelines x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/resumePipeline + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: deprecated: true @@ -52248,6 +52369,8 @@ paths: tags: - Data Lake Pipelines x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/triggerSnapshotIngestion + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService: get: description: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -52640,6 +52763,9 @@ paths: tags: - Private Endpoint Services x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getRegionalizedPrivateEndpointSetting + x-xgen-method-verb-override: + customMethod: "False" + verb: get patch: description: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. The cloud service provider manages the private endpoints for the project. Connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime. To use this resource, the requesting Service Account or API Key must have the Project Owner role and all clusters in the deployment must be sharded clusters. Once enabled, you cannot create replica sets. operationId: toggleRegionalizedPrivateEndpointSetting @@ -52676,6 +52802,9 @@ paths: tags: - Private Endpoint Services x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/toggleRegionalizedPrivateEndpointSetting + x-xgen-method-verb-override: + customMethod: "True" + verb: toggle /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint: get: description: |- @@ -52950,6 +53079,9 @@ paths: tags: - Network Peering x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/verifyConnectViaPeeringOnlyModeForOneProject + x-xgen-method-verb-override: + customMethod: "True" + verb: verify patch: deprecated: true description: Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -52990,6 +53122,9 @@ paths: tags: - Network Peering x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/disablePeering + x-xgen-method-verb-override: + customMethod: "True" + verb: disablePeering /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds: get: description: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. @@ -53316,6 +53451,9 @@ paths: tags: - Collection Level Metrics x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForHost + x-xgen-method-verb-override: + customMethod: "False" + verb: get /api/atlas/v2/groups/{groupId}/processes/{processId}/databases: get: description: Returns the list of databases running on the specified host for the specified project. `M0` free clusters, `M2`, `M5`, serverless, and Flex clusters have some operational limits. The MongoDB Cloud process must be a `mongod`. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -54142,6 +54280,9 @@ paths: tags: - Push-Based Log Export x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/getPushBasedLogConfiguration + x-xgen-method-verb-override: + customMethod: "False" + verb: get patch: description: Updates the project level settings for the push-based log export feature. operationId: updatePushBasedLogConfiguration @@ -54250,6 +54391,9 @@ paths: tags: - Clusters x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/loadSampleDataset + x-xgen-method-verb-override: + customMethod: "True" + verb: request /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}: get: description: Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -54658,6 +54802,9 @@ paths: tags: - Performance Advisor x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getServerlessAutoIndexing + x-xgen-method-verb-override: + customMethod: "False" + verb: get post: description: Set whether the Serverless Auto Indexing feature is enabled. This endpoint sets a value for Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026. externalDocs: @@ -54700,6 +54847,9 @@ paths: tags: - Performance Advisor x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/setServerlessAutoIndexing + x-xgen-method-verb-override: + customMethod: "True" + verb: set /api/atlas/v2/groups/{groupId}/serverless/{name}: delete: description: |- @@ -55600,6 +55750,9 @@ paths: tags: - Streams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/downloadStreamTenantAuditLogs + x-xgen-method-verb-override: + customMethod: "True" + verb: download /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections: get: description: Returns all connections of the stream instance for the specified project.To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. @@ -56196,6 +56349,9 @@ paths: tags: - Streams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getAccountDetails + x-xgen-method-verb-override: + customMethod: "False" + verb: get /api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections: get: description: Returns a list of active incoming VPC Peering Connections. @@ -56535,151 +56691,6 @@ paths: tags: - Streams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstanceWithSampleConnections - /api/atlas/v2/groups/{groupId}/streamsTgwRoutes: - get: - description: List Transit Gateway routes in the default route table associated with Atlas VPC. - operationId: listTransitGatewayRoutes - parameters: - - $ref: '#/components/parameters/groupId' - - $ref: '#/components/parameters/envelope' - - $ref: '#/components/parameters/itemsPerPage' - - $ref: '#/components/parameters/pageNum' - responses: - "200": - content: - application/vnd.atlas.preview+json: - schema: - $ref: '#/components/schemas/PaginatedApiStreamsTransitGatewayRouteResponse' - x-xgen-preview: - name: aws-transit-gateway - x-xgen-version: preview - 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' - summary: Return All Transit Gateway Routes in the Default Route Table for One Atlas VPC - tags: - - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listTransitGatewayRoutes - post: - description: Creates a route in the default route table associated with Atlas VPC to route all traffic destined for provided CIDR to the provided Transit Gateway. - operationId: createTransitGatewayRoute - parameters: - - $ref: '#/components/parameters/groupId' - - $ref: '#/components/parameters/envelope' - requestBody: - content: - application/vnd.atlas.preview+json: - schema: - $ref: '#/components/schemas/StreamsTransitGatewayRouteRequest' - description: Metadata needed for creating a transit gateway route. - required: true - responses: - "201": - content: - application/vnd.atlas.preview+json: - schema: - $ref: '#/components/schemas/StreamsTransitGatewayRouteResponse' - x-xgen-preview: - name: aws-transit-gateway - x-xgen-version: preview - description: Created - "400": - $ref: '#/components/responses/badRequest' - "401": - $ref: '#/components/responses/unauthorized' - "403": - $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/notFound' - "500": - $ref: '#/components/responses/internalServerError' - summary: Creates a route in the default route table associated with Atlas VPC to route all traffic destined for provided CIDR to the provided Transit Gateway. - tags: - - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createTransitGatewayRoute - /api/atlas/v2/groups/{groupId}/streamsTgwRoutes/{routeId}: - delete: - description: Deletes a transit gateway route in the default route table associated with Atlas VPC. - operationId: deleteTransitGatewayRoute - parameters: - - $ref: '#/components/parameters/groupId' - - $ref: '#/components/parameters/envelope' - - description: The Object ID that uniquely identifies a transit gateway route. - in: path - name: routeId - required: true - schema: - example: 32b6e34b3d91647abb20e7b8 - pattern: ^([a-f0-9]{24})$ - type: string - responses: - "204": - content: - application/vnd.atlas.preview+json: - x-xgen-preview: - name: aws-transit-gateway - x-xgen-version: preview - description: No Content - "400": - $ref: '#/components/responses/badRequest' - "401": - $ref: '#/components/responses/unauthorized' - "403": - $ref: '#/components/responses/forbidden' - "404": - $ref: '#/components/responses/notFound' - "500": - $ref: '#/components/responses/internalServerError' - summary: Delete One Transit Gateway Route in the Default Route Table for One Atlas VPC - tags: - - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteTransitGatewayRoute - get: - description: Retrieves a transit gateway route in the default route table associated with Atlas VPC. - operationId: getTransitGatewayRoute - parameters: - - $ref: '#/components/parameters/groupId' - - description: The Object ID that uniquely identifies a transit gateway route. - in: path - name: routeId - required: true - schema: - example: 32b6e34b3d91647abb20e7b8 - pattern: ^([a-f0-9]{24})$ - type: string - - $ref: '#/components/parameters/envelope' - responses: - "200": - content: - application/vnd.atlas.preview+json: - schema: - $ref: '#/components/schemas/StreamsTransitGatewayRouteResponse' - x-xgen-preview: - name: aws-transit-gateway - x-xgen-version: preview - 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' - summary: Return One Transit Gateway Route in the Default Route Table for One Atlas VPC - tags: - - Streams - x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getTransitGatewayRoute /api/atlas/v2/groups/{groupId}/teams: get: description: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -56754,6 +56765,9 @@ paths: tags: - Teams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addAllTeamsToProject + x-xgen-method-verb-override: + customMethod: "True" + verb: add /api/atlas/v2/groups/{groupId}/teams/{teamId}: delete: description: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -56791,6 +56805,9 @@ paths: tags: - Teams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeProjectTeam + x-xgen-method-verb-override: + customMethod: "True" + verb: remove get: description: Returns one team to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. operationId: getProjectTeam @@ -56977,6 +56994,9 @@ paths: tags: - X.509 Authentication x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/disableCustomerManagedX509 + x-xgen-method-verb-override: + customMethod: "True" + verb: disable /api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping: delete: description: Removes the current LDAP Distinguished Name mapping captured in the ``userToDNMapping`` document from the LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -57042,6 +57062,8 @@ paths: tags: - LDAP Configuration x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/verifyLdapConfiguration + x-xgen-method-verb-override: + customMethod: "True" /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}: get: description: Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -57077,6 +57099,9 @@ paths: tags: - LDAP Configuration x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfigurationStatus + x-xgen-method-verb-override: + customMethod: "False" + verb: get /api/atlas/v2/groups/{groupId}/users: get: description: |- @@ -57183,6 +57208,9 @@ paths: tags: - MongoDB Cloud Users x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectUser + x-xgen-method-verb-override: + customMethod: "True" + verb: add /api/atlas/v2/groups/{groupId}/users/{userId}: delete: description: |- @@ -57231,6 +57259,9 @@ paths: tags: - MongoDB Cloud Users x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectUser + x-xgen-method-verb-override: + customMethod: "True" + verb: remove get: description: |- Returns information about the specified MongoDB Cloud user within the context of the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -57349,7 +57380,7 @@ paths: content: application/vnd.atlas.2025-02-19+json: schema: - $ref: '#/components/schemas/OrgUserResponse' + $ref: '#/components/schemas/GroupUserResponse' x-xgen-version: "2025-02-19" description: OK "400": @@ -57401,7 +57432,7 @@ paths: content: application/vnd.atlas.2025-02-19+json: schema: - $ref: '#/components/schemas/OrgUserResponse' + $ref: '#/components/schemas/GroupUserResponse' x-xgen-version: "2025-02-19" description: OK "400": @@ -58010,6 +58041,9 @@ paths: tags: - Programmatic API Keys x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKeyAccessListEntry + x-xgen-method-verb-override: + customMethod: "True" + verb: deleteEntry get: description: Returns one access list entry for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Organization Member role. externalDocs: @@ -59610,6 +59644,9 @@ paths: tags: - Service Accounts x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountAccessListEntry + x-xgen-method-verb-override: + customMethod: "True" + verb: deleteEntry /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups: get: description: Returns a list of all projects the specified Service Account is a part of. @@ -60006,6 +60043,9 @@ paths: tags: - Teams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/renameTeam + x-xgen-method-verb-override: + customMethod: "True" + verb: rename /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users: get: description: |- @@ -60043,6 +60083,12 @@ paths: schema: example: ACTIVE type: string + - description: Unique 24-hexadecimal digit string to filter users by. Not supported in deprecated versions. + in: query + name: userId + schema: + pattern: ^([a-f0-9]{24})$ + type: string responses: "200": content: @@ -60127,6 +60173,9 @@ paths: tags: - Teams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addTeamUser + x-xgen-method-verb-override: + customMethod: "True" + verb: add /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}: delete: deprecated: true @@ -60177,6 +60226,9 @@ paths: tags: - Teams x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeTeamUser + x-xgen-method-verb-override: + customMethod: "True" + verb: remove /api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser: post: description: |- @@ -60463,6 +60515,9 @@ paths: tags: - MongoDB Cloud Users x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationUser + x-xgen-method-verb-override: + customMethod: "True" + verb: remove get: description: |- Returns information about the specified MongoDB Cloud user within the context of the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Member role. @@ -60942,7 +60997,7 @@ tags: 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. + - description: Creates one index to a database deployment in a rolling manner. Rolling indexes build indexes on the applicable nodes sequentially and may reduce the performance impact of an index build if your deployment's average CPU utilization exceeds (N-1)/N-10% where N is the number of CPU threads available to mongod of if the WiredTiger cache fill ratio regularly exceeds 90%. If your deployment does not meet this criteria, use the default index build. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster. name: Rolling Index - description: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API. name: Root