From c7d7556a70cdad3cd5feed04200ad446278d9d89 Mon Sep 17 00:00:00 2001 From: Luke Sanderson Date: Thu, 25 Sep 2025 15:26:43 +0100 Subject: [PATCH 01/11] Remove public preview from docs generation --- tools/cmd/docs/api_docs_long_text.txt | 3 --- tools/cmd/docs/transformations.go | 10 ---------- 2 files changed, 13 deletions(-) diff --git a/tools/cmd/docs/api_docs_long_text.txt b/tools/cmd/docs/api_docs_long_text.txt index c816d86b23..f99762128f 100644 --- a/tools/cmd/docs/api_docs_long_text.txt +++ b/tools/cmd/docs/api_docs_long_text.txt @@ -1,6 +1,3 @@ -Public Preview: 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. - Syntax ------ diff --git a/tools/cmd/docs/transformations.go b/tools/cmd/docs/transformations.go index a9aba25d31..c68c61b225 100644 --- a/tools/cmd/docs/transformations.go +++ b/tools/cmd/docs/transformations.go @@ -24,7 +24,6 @@ import ( "strconv" "strings" - "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli" pluginCmd "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli/plugin" "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/plugin" "github.com/mongodb/mongodb-atlas-cli/atlascli/tools/internal/metadatatypes" @@ -57,14 +56,6 @@ func setDisableAutoGenTag(cmd *cobra.Command) { cmd.DisableAutoGenTag = true } -func markExperimentalToAPICommands(cmd *cobra.Command) { - if cmd.CommandPath() == "atlas api" { - return // Skip the root command - } - cmd.Short = "`Public Preview: please provide feedback `_: " + cmd.Short - cmd.Long = cli.ExperimentalText + cmd.Long -} - func updateAPICommandDescription(cmd *cobra.Command) { if len(cmd.Commands()) > 0 { return @@ -285,7 +276,6 @@ func applyTransformations(cmd *cobra.Command) error { if isAPICommand(cmd) { removeCommandsWithOnlyPrivatePreview(cmd) - markExperimentalToAPICommands(cmd) updateAPICommandDescription(cmd) if err := updateExamples(cmd); err != nil { return err From 9a14f2f324bc5aab2c8e800f1cbf994e27ef0bc0 Mon Sep 17 00:00:00 2001 From: Luke Sanderson Date: Thu, 25 Sep 2025 15:43:14 +0100 Subject: [PATCH 02/11] Remove api specific public preview help template --- internal/cli/api/api.go | 6 +++--- internal/cli/help_templates.go | 8 -------- 2 files changed, 3 insertions(+), 11 deletions(-) diff --git a/internal/cli/api/api.go b/internal/cli/api/api.go index 244436dc17..b46772c497 100644 --- a/internal/cli/api/api.go +++ b/internal/cli/api/api.go @@ -71,15 +71,15 @@ func Builder() *cobra.Command { func createRootAPICommand() *cobra.Command { rootCmd := &cobra.Command{ Use: "api", - Short: "`Public Preview: please provide feedback `_: " + `Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '.`, - Long: `This feature in public preview streamlines script development by letting you interact directly with any Atlas Administration API endpoint by using the Atlas CLI. + Short: `Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '.`, + Long: `This feature streamlines script development by letting you interact directly with any Atlas Administration API endpoint by using the Atlas CLI. For more information on - Atlas Administration API see: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/ - Getting started with the Atlas Administration API: https://www.mongodb.com/docs/atlas/configure-api-access/#std-label-atlas-admin-api-access`, } - rootCmd.SetHelpTemplate(cli.ExperimentalHelpTemplate) + rootCmd.SetHelpTemplate(cli.HelpTemplate) return rootCmd } diff --git a/internal/cli/help_templates.go b/internal/cli/help_templates.go index 775b45cfe1..daaf8a70c3 100644 --- a/internal/cli/help_templates.go +++ b/internal/cli/help_templates.go @@ -21,12 +21,4 @@ const ( {{if or .Runnable .HasSubCommands}}{{.UsageString}}{{end}}` - ExperimentalText = "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).\n" + - "Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint " + - "documentation link.\n\n" - - ExperimentalHelpTemplate = "Public Preview: " + ExperimentalText + HelpTemplate ) From da572f8e672bc72079238b144ccc7354736745f1 Mon Sep 17 00:00:00 2001 From: Luke Sanderson Date: Thu, 25 Sep 2025 15:44:14 +0100 Subject: [PATCH 03/11] Run make gen-docs --- ...ssTracking-listAccessLogsByClusterName.txt | 5 +- ...ccessTracking-listAccessLogsByHostname.txt | 5 +- docs/command/atlas-api-accessTracking.txt | 9 +- ...onfigurations-createAlertConfiguration.txt | 5 +- ...onfigurations-deleteAlertConfiguration.txt | 5 +- ...rtConfigurations-getAlertConfiguration.txt | 5 +- ...stAlertConfigurationMatchersFieldNames.txt | 5 +- ...Configurations-listAlertConfigurations.txt | 5 +- ...tions-listAlertConfigurationsByAlertId.txt | 5 +- ...onfigurations-toggleAlertConfiguration.txt | 5 +- ...onfigurations-updateAlertConfiguration.txt | 5 +- .../command/atlas-api-alertConfigurations.txt | 21 ++-- .../atlas-api-alerts-acknowledgeAlert.txt | 5 +- docs/command/atlas-api-alerts-getAlert.txt | 5 +- docs/command/atlas-api-alerts-listAlerts.txt | 5 +- ...lerts-listAlertsByAlertConfigurationId.txt | 5 +- docs/command/atlas-api-alerts.txt | 13 +-- ...tlasSearch-createAtlasSearchDeployment.txt | 5 +- ...api-atlasSearch-createAtlasSearchIndex.txt | 5 +- ...earch-createAtlasSearchIndexDeprecated.txt | 5 +- ...tlasSearch-deleteAtlasSearchDeployment.txt | 5 +- ...api-atlasSearch-deleteAtlasSearchIndex.txt | 5 +- ...lasSearch-deleteAtlasSearchIndexByName.txt | 5 +- ...earch-deleteAtlasSearchIndexDeprecated.txt | 5 +- ...i-atlasSearch-getAtlasSearchDeployment.txt | 5 +- ...as-api-atlasSearch-getAtlasSearchIndex.txt | 5 +- ...-atlasSearch-getAtlasSearchIndexByName.txt | 5 +- ...asSearch-getAtlasSearchIndexDeprecated.txt | 5 +- ...api-atlasSearch-listAtlasSearchIndexes.txt | 5 +- ...asSearch-listAtlasSearchIndexesCluster.txt | 5 +- ...earch-listAtlasSearchIndexesDeprecated.txt | 5 +- ...tlasSearch-updateAtlasSearchDeployment.txt | 5 +- ...api-atlasSearch-updateAtlasSearchIndex.txt | 5 +- ...lasSearch-updateAtlasSearchIndexByName.txt | 5 +- ...earch-updateAtlasSearchIndexDeprecated.txt | 5 +- docs/command/atlas-api-atlasSearch.txt | 41 ++++--- ...-api-auditing-getAuditingConfiguration.txt | 5 +- ...i-auditing-updateAuditingConfiguration.txt | 5 +- docs/command/atlas-api-auditing.txt | 11 +- ...las-api-awsClustersDns-getAwsCustomDns.txt | 5 +- ...-api-awsClustersDns-toggleAwsCustomDns.txt | 5 +- docs/command/atlas-api-awsClustersDns.txt | 9 +- ...pi-cloudBackups-cancelBackupRestoreJob.txt | 5 +- ...api-cloudBackups-createBackupExportJob.txt | 5 +- ...pi-cloudBackups-createBackupRestoreJob.txt | 5 +- ...as-api-cloudBackups-createExportBucket.txt | 5 +- ...ckups-createServerlessBackupRestoreJob.txt | 5 +- ...-cloudBackups-deleteAllBackupSchedules.txt | 5 +- ...as-api-cloudBackups-deleteExportBucket.txt | 5 +- ...pi-cloudBackups-deleteReplicaSetBackup.txt | 5 +- ...loudBackups-deleteShardedClusterBackup.txt | 5 +- ...dBackups-disableDataProtectionSettings.txt | 5 +- ...as-api-cloudBackups-getBackupExportJob.txt | 5 +- ...s-api-cloudBackups-getBackupRestoreJob.txt | 5 +- ...las-api-cloudBackups-getBackupSchedule.txt | 5 +- ...cloudBackups-getDataProtectionSettings.txt | 5 +- ...atlas-api-cloudBackups-getExportBucket.txt | 5 +- ...s-api-cloudBackups-getReplicaSetBackup.txt | 5 +- ...s-api-cloudBackups-getServerlessBackup.txt | 5 +- ...dBackups-getServerlessBackupRestoreJob.txt | 5 +- ...i-cloudBackups-getShardedClusterBackup.txt | 5 +- ...-api-cloudBackups-listBackupExportJobs.txt | 5 +- ...api-cloudBackups-listBackupRestoreJobs.txt | 5 +- ...las-api-cloudBackups-listExportBuckets.txt | 5 +- ...api-cloudBackups-listReplicaSetBackups.txt | 5 +- ...ackups-listServerlessBackupRestoreJobs.txt | 5 +- ...api-cloudBackups-listServerlessBackups.txt | 5 +- ...cloudBackups-listShardedClusterBackups.txt | 5 +- .../atlas-api-cloudBackups-takeSnapshot.txt | 5 +- ...-api-cloudBackups-updateBackupSchedule.txt | 5 +- ...udBackups-updateDataProtectionSettings.txt | 5 +- ...i-cloudBackups-updateSnapshotRetention.txt | 5 +- docs/command/atlas-api-cloudBackups.txt | 65 +++++------ ...-cloudMigrationService-createLinkToken.txt | 5 +- ...udMigrationService-createPushMigration.txt | 5 +- ...cloudMigrationService-cutoverMigration.txt | 5 +- ...-cloudMigrationService-deleteLinkToken.txt | 5 +- ...cloudMigrationService-getPushMigration.txt | 5 +- ...udMigrationService-getValidationStatus.txt | 5 +- ...oudMigrationService-listSourceProjects.txt | 5 +- ...loudMigrationService-validateMigration.txt | 5 +- .../atlas-api-cloudMigrationService.txt | 21 ++-- ...ccess-authorizeCloudProviderAccessRole.txt | 5 +- ...erAccess-createCloudProviderAccessRole.txt | 5 +- ...ess-deauthorizeCloudProviderAccessRole.txt | 5 +- ...viderAccess-getCloudProviderAccessRole.txt | 5 +- ...derAccess-listCloudProviderAccessRoles.txt | 5 +- .../command/atlas-api-cloudProviderAccess.txt | 17 +-- ...erOutageSimulation-endOutageSimulation.txt | 5 +- ...erOutageSimulation-getOutageSimulation.txt | 5 +- ...OutageSimulation-startOutageSimulation.txt | 5 +- .../atlas-api-clusterOutageSimulation.txt | 13 +-- ...-api-clusters-autoScalingConfiguration.txt | 5 +- .../atlas-api-clusters-createCluster.txt | 5 +- .../atlas-api-clusters-deleteCluster.txt | 5 +- .../command/atlas-api-clusters-getCluster.txt | 5 +- ...usters-getClusterAdvancedConfiguration.txt | 5 +- .../atlas-api-clusters-getClusterStatus.txt | 5 +- ...pi-clusters-getSampleDatasetLoadStatus.txt | 5 +- ...pi-clusters-grantMongoDbEmployeeAccess.txt | 5 +- ...-api-clusters-listCloudProviderRegions.txt | 5 +- .../atlas-api-clusters-listClusters.txt | 5 +- ...pi-clusters-listClustersForAllProjects.txt | 5 +- .../atlas-api-clusters-loadSampleDataset.txt | 5 +- ...lusters-pinFeatureCompatibilityVersion.txt | 5 +- ...i-clusters-revokeMongoDbEmployeeAccess.txt | 5 +- .../atlas-api-clusters-testFailover.txt | 5 +- ...sters-unpinFeatureCompatibilityVersion.txt | 5 +- .../atlas-api-clusters-updateCluster.txt | 5 +- ...ers-updateClusterAdvancedConfiguration.txt | 5 +- ...tlas-api-clusters-upgradeSharedCluster.txt | 5 +- docs/command/atlas-api-clusters.txt | 43 ++++--- ...atsLatencyNamespaceClusterMeasurements.txt | 5 +- ...lStatsLatencyNamespaceHostMeasurements.txt | 5 +- ...cs-getCollStatsLatencyNamespaceMetrics.txt | 5 +- ...etCollStatsLatencyNamespacesForCluster.txt | 5 +- ...s-getCollStatsLatencyNamespacesForHost.txt | 5 +- ...ectionLevelMetrics-getPinnedNamespaces.txt | 5 +- ...lectionLevelMetrics-pinNamespacesPatch.txt | 5 +- ...ollectionLevelMetrics-pinNamespacesPut.txt | 5 +- ...collectionLevelMetrics-unpinNamespaces.txt | 5 +- .../atlas-api-collectionLevelMetrics.txt | 23 ++-- ...DatabaseRoles-createCustomDatabaseRole.txt | 5 +- ...DatabaseRoles-deleteCustomDatabaseRole.txt | 5 +- ...tomDatabaseRoles-getCustomDatabaseRole.txt | 5 +- ...mDatabaseRoles-listCustomDatabaseRoles.txt | 5 +- ...DatabaseRoles-updateCustomDatabaseRole.txt | 5 +- .../command/atlas-api-customDatabaseRoles.txt | 15 +-- ...on-createDataFederationPrivateEndpoint.txt | 5 +- ...dataFederation-createFederatedDatabase.txt | 5 +- ...tion-createOneDataFederationQueryLimit.txt | 5 +- ...on-deleteDataFederationPrivateEndpoint.txt | 5 +- ...dataFederation-deleteFederatedDatabase.txt | 5 +- ...eteOneDataFederationInstanceQueryLimit.txt | 5 +- ...ion-downloadFederatedDatabaseQueryLogs.txt | 5 +- ...ation-getDataFederationPrivateEndpoint.txt | 5 +- ...pi-dataFederation-getFederatedDatabase.txt | 5 +- ...ion-listDataFederationPrivateEndpoints.txt | 5 +- ...-dataFederation-listFederatedDatabases.txt | 5 +- ...tion-returnFederatedDatabaseQueryLimit.txt | 5 +- ...ion-returnFederatedDatabaseQueryLimits.txt | 5 +- ...dataFederation-updateFederatedDatabase.txt | 5 +- docs/command/atlas-api-dataFederation.txt | 33 +++--- ...s-api-databaseUsers-createDatabaseUser.txt | 5 +- ...s-api-databaseUsers-deleteDatabaseUser.txt | 5 +- ...tlas-api-databaseUsers-getDatabaseUser.txt | 5 +- ...as-api-databaseUsers-listDatabaseUsers.txt | 5 +- ...s-api-databaseUsers-updateDatabaseUser.txt | 5 +- docs/command/atlas-api-databaseUsers.txt | 17 +-- ...-createEncryptionAtRestPrivateEndpoint.txt | 5 +- ...tomerKeyManagement-getEncryptionAtRest.txt | 5 +- ...ent-getEncryptionAtRestPrivateEndpoint.txt | 5 +- ...AtRestPrivateEndpointsForCloudProvider.txt | 5 +- ...ncryptionAtRestPrivateEndpointDeletion.txt | 5 +- ...erKeyManagement-updateEncryptionAtRest.txt | 5 +- ...yptionAtRestUsingCustomerKeyManagement.txt | 17 ++- .../atlas-api-events-getOrganizationEvent.txt | 5 +- .../atlas-api-events-getProjectEvent.txt | 5 +- .../atlas-api-events-listEventTypes.txt | 5 +- ...tlas-api-events-listOrganizationEvents.txt | 5 +- .../atlas-api-events-listProjectEvents.txt | 5 +- docs/command/atlas-api-events.txt | 15 +-- ...dAuthentication-createIdentityProvider.txt | 5 +- ...eratedAuthentication-createRoleMapping.txt | 5 +- ...atedAuthentication-deleteFederationApp.txt | 5 +- ...dAuthentication-deleteIdentityProvider.txt | 5 +- ...eratedAuthentication-deleteRoleMapping.txt | 5 +- ...edAuthentication-getConnectedOrgConfig.txt | 5 +- ...edAuthentication-getFederationSettings.txt | 5 +- ...atedAuthentication-getIdentityProvider.txt | 5 +- ...entication-getIdentityProviderMetadata.txt | 5 +- ...federatedAuthentication-getRoleMapping.txt | 5 +- ...Authentication-listConnectedOrgConfigs.txt | 5 +- ...edAuthentication-listIdentityProviders.txt | 5 +- ...deratedAuthentication-listRoleMappings.txt | 5 +- ...uthentication-removeConnectedOrgConfig.txt | 5 +- ...ication-revokeJwksFromIdentityProvider.txt | 5 +- ...uthentication-updateConnectedOrgConfig.txt | 5 +- ...dAuthentication-updateIdentityProvider.txt | 5 +- ...eratedAuthentication-updateRoleMapping.txt | 5 +- .../atlas-api-federatedAuthentication.txt | 43 ++++--- ...las-api-flexClusters-createFlexCluster.txt | 5 +- ...las-api-flexClusters-deleteFlexCluster.txt | 5 +- .../atlas-api-flexClusters-getFlexCluster.txt | 5 +- ...tlas-api-flexClusters-listFlexClusters.txt | 5 +- ...las-api-flexClusters-updateFlexCluster.txt | 5 +- ...as-api-flexClusters-upgradeFlexCluster.txt | 5 +- docs/command/atlas-api-flexClusters.txt | 19 ++-- ...RestoreJobs-createFlexBackupRestoreJob.txt | 5 +- ...lexRestoreJobs-getFlexBackupRestoreJob.txt | 5 +- ...xRestoreJobs-listFlexBackupRestoreJobs.txt | 5 +- docs/command/atlas-api-flexRestoreJobs.txt | 13 +-- ...s-api-flexSnapshots-downloadFlexBackup.txt | 5 +- .../atlas-api-flexSnapshots-getFlexBackup.txt | 5 +- ...tlas-api-flexSnapshots-listFlexBackups.txt | 5 +- docs/command/atlas-api-flexSnapshots.txt | 13 +-- ...globalClusters-createCustomZoneMapping.txt | 5 +- ...-globalClusters-createManagedNamespace.txt | 5 +- ...alClusters-deleteAllCustomZoneMappings.txt | 5 +- ...-globalClusters-deleteManagedNamespace.txt | 5 +- ...api-globalClusters-getManagedNamespace.txt | 5 +- docs/command/atlas-api-globalClusters.txt | 15 +-- ...nvoices-createCostExplorerQueryProcess.txt | 5 +- .../atlas-api-invoices-downloadInvoiceCsv.txt | 5 +- ...i-invoices-getCostExplorerQueryProcess.txt | 5 +- .../command/atlas-api-invoices-getInvoice.txt | 5 +- .../atlas-api-invoices-listInvoices.txt | 5 +- ...atlas-api-invoices-listPendingInvoices.txt | 5 +- ...voices-queryLineItemsFromSingleInvoice.txt | 5 +- docs/command/atlas-api-invoices.txt | 21 ++-- ...pConfiguration-deleteLdapConfiguration.txt | 5 +- ...ldapConfiguration-getLdapConfiguration.txt | 5 +- ...nfiguration-getLdapConfigurationStatus.txt | 5 +- ...dapConfiguration-saveLdapConfiguration.txt | 5 +- ...pConfiguration-verifyLdapConfiguration.txt | 5 +- docs/command/atlas-api-ldapConfiguration.txt | 15 +-- ...acyBackup-createLegacyBackupRestoreJob.txt | 5 +- ...-api-legacyBackup-deleteLegacySnapshot.txt | 5 +- ...legacyBackup-getLegacyBackupCheckpoint.txt | 5 +- ...legacyBackup-getLegacyBackupRestoreJob.txt | 5 +- ...las-api-legacyBackup-getLegacySnapshot.txt | 5 +- ...legacyBackup-getLegacySnapshotSchedule.txt | 5 +- ...gacyBackup-listLegacyBackupCheckpoints.txt | 5 +- ...gacyBackup-listLegacyBackupRestoreJobs.txt | 5 +- ...s-api-legacyBackup-listLegacySnapshots.txt | 5 +- ...cyBackup-updateLegacySnapshotRetention.txt | 5 +- ...acyBackup-updateLegacySnapshotSchedule.txt | 5 +- docs/command/atlas-api-legacyBackup.txt | 29 ++--- ...ntenanceWindows-deferMaintenanceWindow.txt | 5 +- ...aintenanceWindows-getMaintenanceWindow.txt | 5 +- ...ntenanceWindows-resetMaintenanceWindow.txt | 5 +- ...anceWindows-toggleMaintenanceAutoDefer.txt | 5 +- ...tenanceWindows-updateMaintenanceWindow.txt | 5 +- docs/command/atlas-api-maintenanceWindows.txt | 15 +-- ...-mongoDbCloudUsers-addOrganizationRole.txt | 5 +- ...s-api-mongoDbCloudUsers-addProjectRole.txt | 5 +- ...s-api-mongoDbCloudUsers-addProjectUser.txt | 5 +- ...as-api-mongoDbCloudUsers-addUserToTeam.txt | 5 +- ...ngoDbCloudUsers-createOrganizationUser.txt | 5 +- ...atlas-api-mongoDbCloudUsers-createUser.txt | 5 +- ...-mongoDbCloudUsers-getOrganizationUser.txt | 5 +- ...s-api-mongoDbCloudUsers-getProjectUser.txt | 5 +- .../atlas-api-mongoDbCloudUsers-getUser.txt | 5 +- ...pi-mongoDbCloudUsers-getUserByUsername.txt | 5 +- ...ongoDbCloudUsers-listOrganizationUsers.txt | 5 +- ...api-mongoDbCloudUsers-listProjectUsers.txt | 5 +- ...as-api-mongoDbCloudUsers-listTeamUsers.txt | 5 +- ...ngoDbCloudUsers-removeOrganizationRole.txt | 5 +- ...ngoDbCloudUsers-removeOrganizationUser.txt | 5 +- ...pi-mongoDbCloudUsers-removeProjectRole.txt | 5 +- ...pi-mongoDbCloudUsers-removeProjectUser.txt | 5 +- ...i-mongoDbCloudUsers-removeUserFromTeam.txt | 5 +- ...ngoDbCloudUsers-updateOrganizationUser.txt | 5 +- docs/command/atlas-api-mongoDbCloudUsers.txt | 45 ++++---- ...-api-monitoringAndLogs-getAtlasProcess.txt | 5 +- ...tlas-api-monitoringAndLogs-getDatabase.txt | 5 +- ...itoringAndLogs-getDatabaseMeasurements.txt | 5 +- ...-monitoringAndLogs-getDiskMeasurements.txt | 5 +- ...tlas-api-monitoringAndLogs-getHostLogs.txt | 5 +- ...-monitoringAndLogs-getHostMeasurements.txt | 5 +- ...-api-monitoringAndLogs-getIndexMetrics.txt | 5 +- ...-api-monitoringAndLogs-getMeasurements.txt | 5 +- ...i-monitoringAndLogs-listAtlasProcesses.txt | 5 +- ...as-api-monitoringAndLogs-listDatabases.txt | 5 +- ...monitoringAndLogs-listDiskMeasurements.txt | 5 +- ...i-monitoringAndLogs-listDiskPartitions.txt | 5 +- ...api-monitoringAndLogs-listIndexMetrics.txt | 5 +- ...-api-monitoringAndLogs-listMetricTypes.txt | 5 +- docs/command/atlas-api-monitoringAndLogs.txt | 35 +++--- ...networkPeering-createPeeringConnection.txt | 5 +- ...-networkPeering-createPeeringContainer.txt | 5 +- ...networkPeering-deletePeeringConnection.txt | 5 +- ...-networkPeering-deletePeeringContainer.txt | 5 +- ...tlas-api-networkPeering-disablePeering.txt | 5 +- ...pi-networkPeering-getPeeringConnection.txt | 5 +- ...api-networkPeering-getPeeringContainer.txt | 5 +- ...-networkPeering-listPeeringConnections.txt | 5 +- ...ng-listPeeringContainerByCloudProvider.txt | 5 +- ...i-networkPeering-listPeeringContainers.txt | 5 +- ...networkPeering-updatePeeringConnection.txt | 5 +- ...-networkPeering-updatePeeringContainer.txt | 5 +- ...ConnectViaPeeringOnlyModeForOneProject.txt | 5 +- docs/command/atlas-api-networkPeering.txt | 31 +++-- ...-api-onlineArchive-createOnlineArchive.txt | 5 +- ...-api-onlineArchive-deleteOnlineArchive.txt | 5 +- ...Archive-downloadOnlineArchiveQueryLogs.txt | 5 +- ...las-api-onlineArchive-getOnlineArchive.txt | 5 +- ...s-api-onlineArchive-listOnlineArchives.txt | 5 +- ...-api-onlineArchive-updateOnlineArchive.txt | 5 +- docs/command/atlas-api-onlineArchive.txt | 19 ++-- ...s-api-organizations-createOrganization.txt | 5 +- ...nizations-createOrganizationInvitation.txt | 5 +- ...s-api-organizations-deleteOrganization.txt | 5 +- ...nizations-deleteOrganizationInvitation.txt | 5 +- ...tlas-api-organizations-getOrganization.txt | 5 +- ...rganizations-getOrganizationInvitation.txt | 5 +- ...-organizations-getOrganizationSettings.txt | 5 +- ...anizations-listOrganizationInvitations.txt | 5 +- ...organizations-listOrganizationProjects.txt | 5 +- ...as-api-organizations-listOrganizations.txt | 5 +- ...s-api-organizations-updateOrganization.txt | 5 +- ...nizations-updateOrganizationInvitation.txt | 5 +- ...tions-updateOrganizationInvitationById.txt | 5 +- ...-organizations-updateOrganizationRoles.txt | 5 +- ...ganizations-updateOrganizationSettings.txt | 5 +- docs/command/atlas-api-organizations.txt | 37 +++--- ...visor-disableSlowOperationThresholding.txt | 5 +- ...dvisor-enableSlowOperationThresholding.txt | 5 +- ...pi-performanceAdvisor-getManagedSlowMs.txt | 5 +- ...manceAdvisor-getServerlessAutoIndexing.txt | 5 +- ...nceAdvisor-listClusterSuggestedIndexes.txt | 5 +- ...api-performanceAdvisor-listDropIndexes.txt | 5 +- ...pi-performanceAdvisor-listSchemaAdvice.txt | 5 +- ...api-performanceAdvisor-listSlowQueries.txt | 5 +- ...ormanceAdvisor-listSlowQueryNamespaces.txt | 5 +- ...erformanceAdvisor-listSuggestedIndexes.txt | 5 +- ...manceAdvisor-setServerlessAutoIndexing.txt | 5 +- docs/command/atlas-api-performanceAdvisor.txt | 27 ++--- ...EndpointServices-createPrivateEndpoint.txt | 5 +- ...tServices-createPrivateEndpointService.txt | 5 +- ...EndpointServices-deletePrivateEndpoint.txt | 5 +- ...tServices-deletePrivateEndpointService.txt | 5 +- ...ateEndpointServices-getPrivateEndpoint.txt | 5 +- ...ointServices-getPrivateEndpointService.txt | 5 +- ...-getRegionalizedPrivateEndpointSetting.txt | 5 +- ...ntServices-listPrivateEndpointServices.txt | 5 +- ...ggleRegionalizedPrivateEndpointSetting.txt | 5 +- .../atlas-api-privateEndpointServices.txt | 25 ++-- ...i-programmaticApiKeys-addProjectApiKey.txt | 5 +- ...s-api-programmaticApiKeys-createApiKey.txt | 5 +- ...rammaticApiKeys-createApiKeyAccessList.txt | 5 +- ...rogrammaticApiKeys-createProjectApiKey.txt | 5 +- ...s-api-programmaticApiKeys-deleteApiKey.txt | 5 +- ...ticApiKeys-deleteApiKeyAccessListEntry.txt | 5 +- ...tlas-api-programmaticApiKeys-getApiKey.txt | 5 +- ...rogrammaticApiKeys-getApiKeyAccessList.txt | 5 +- ...icApiKeys-listApiKeyAccessListsEntries.txt | 5 +- ...as-api-programmaticApiKeys-listApiKeys.txt | 5 +- ...programmaticApiKeys-listProjectApiKeys.txt | 5 +- ...rogrammaticApiKeys-removeProjectApiKey.txt | 5 +- ...s-api-programmaticApiKeys-updateApiKey.txt | 5 +- ...-programmaticApiKeys-updateApiKeyRoles.txt | 5 +- .../command/atlas-api-programmaticApiKeys.txt | 33 +++--- ...IpAccessList-createProjectIpAccessList.txt | 5 +- ...IpAccessList-deleteProjectIpAccessList.txt | 5 +- ...ccessList-getProjectIpAccessListStatus.txt | 5 +- ...i-projectIpAccessList-getProjectIpList.txt | 5 +- ...tIpAccessList-listProjectIpAccessLists.txt | 5 +- .../command/atlas-api-projectIpAccessList.txt | 15 +-- .../atlas-api-projects-addUserToProject.txt | 5 +- .../atlas-api-projects-createProject.txt | 5 +- ...s-api-projects-createProjectInvitation.txt | 5 +- .../atlas-api-projects-deleteProject.txt | 5 +- ...s-api-projects-deleteProjectInvitation.txt | 5 +- .../atlas-api-projects-deleteProjectLimit.txt | 5 +- .../command/atlas-api-projects-getProject.txt | 5 +- .../atlas-api-projects-getProjectByName.txt | 5 +- ...tlas-api-projects-getProjectInvitation.txt | 5 +- .../atlas-api-projects-getProjectLimit.txt | 5 +- ...las-api-projects-getProjectLtsVersions.txt | 5 +- .../atlas-api-projects-getProjectSettings.txt | 5 +- ...as-api-projects-listProjectInvitations.txt | 5 +- .../atlas-api-projects-listProjectLimits.txt | 5 +- .../atlas-api-projects-listProjects.txt | 5 +- ...pi-projects-migrateProjectToAnotherOrg.txt | 5 +- ...tlas-api-projects-returnAllIpAddresses.txt | 5 +- .../atlas-api-projects-setProjectLimit.txt | 5 +- .../atlas-api-projects-updateProject.txt | 5 +- ...s-api-projects-updateProjectInvitation.txt | 5 +- ...i-projects-updateProjectInvitationById.txt | 5 +- .../atlas-api-projects-updateProjectRoles.txt | 5 +- ...las-api-projects-updateProjectSettings.txt | 5 +- docs/command/atlas-api-projects.txt | 53 ++++----- ...Export-createPushBasedLogConfiguration.txt | 5 +- ...Export-deletePushBasedLogConfiguration.txt | 5 +- ...LogExport-getPushBasedLogConfiguration.txt | 5 +- ...Export-updatePushBasedLogConfiguration.txt | 5 +- docs/command/atlas-api-pushBasedLogExport.txt | 13 +-- ...etGroupClusterQueryShapeInsightDetails.txt | 5 +- ...GroupClusterQueryShapeInsightSummaries.txt | 5 +- docs/command/atlas-api-queryShapeInsights.txt | 9 +- ...sourcePolicies-createOrgResourcePolicy.txt | 5 +- ...sourcePolicies-deleteOrgResourcePolicy.txt | 5 +- ...-resourcePolicies-getOrgResourcePolicy.txt | 5 +- ...ourcePolicies-getResourcesNonCompliant.txt | 5 +- ...sourcePolicies-listOrgResourcePolicies.txt | 5 +- ...sourcePolicies-updateOrgResourcePolicy.txt | 5 +- ...cePolicies-validateAtlasResourcePolicy.txt | 5 +- docs/command/atlas-api-resourcePolicies.txt | 21 ++-- ...as-api-rollingIndex-createRollingIndex.txt | 5 +- docs/command/atlas-api-rollingIndex.txt | 7 +- .../atlas-api-root-getSystemStatus.txt | 5 +- ...-root-returnAllControlPlaneIpAddresses.txt | 5 +- docs/command/atlas-api-root.txt | 9 +- ...lessInstances-createServerlessInstance.txt | 5 +- ...lessInstances-deleteServerlessInstance.txt | 5 +- ...verlessInstances-getServerlessInstance.txt | 5 +- ...rlessInstances-listServerlessInstances.txt | 5 +- ...lessInstances-updateServerlessInstance.txt | 5 +- .../command/atlas-api-serverlessInstances.txt | 17 +-- ...points-createServerlessPrivateEndpoint.txt | 5 +- ...points-deleteServerlessPrivateEndpoint.txt | 5 +- ...Endpoints-getServerlessPrivateEndpoint.txt | 5 +- ...dpoints-listServerlessPrivateEndpoints.txt | 5 +- ...points-updateServerlessPrivateEndpoint.txt | 5 +- .../atlas-api-serverlessPrivateEndpoints.txt | 15 +-- ...rviceAccounts-addProjectServiceAccount.txt | 5 +- ...ceAccounts-createProjectServiceAccount.txt | 5 +- ...-createProjectServiceAccountAccessList.txt | 5 +- ...unts-createProjectServiceAccountSecret.txt | 5 +- ...i-serviceAccounts-createServiceAccount.txt | 5 +- ...ccounts-createServiceAccountAccessList.txt | 5 +- ...iceAccounts-createServiceAccountSecret.txt | 5 +- ...ceAccounts-deleteProjectServiceAccount.txt | 5 +- ...teProjectServiceAccountAccessListEntry.txt | 5 +- ...unts-deleteProjectServiceAccountSecret.txt | 5 +- ...i-serviceAccounts-deleteServiceAccount.txt | 5 +- ...ts-deleteServiceAccountAccessListEntry.txt | 5 +- ...iceAccounts-deleteServiceAccountSecret.txt | 5 +- ...rviceAccounts-getProjectServiceAccount.txt | 5 +- ...-api-serviceAccounts-getServiceAccount.txt | 5 +- ...ts-listProjectServiceAccountAccessList.txt | 5 +- ...iceAccounts-listProjectServiceAccounts.txt | 5 +- ...eAccounts-listServiceAccountAccessList.txt | 5 +- ...iceAccounts-listServiceAccountProjects.txt | 5 +- ...pi-serviceAccounts-listServiceAccounts.txt | 5 +- ...ceAccounts-updateProjectServiceAccount.txt | 5 +- ...i-serviceAccounts-updateServiceAccount.txt | 5 +- docs/command/atlas-api-serviceAccounts.txt | 49 ++++---- ...bs-createSharedClusterBackupRestoreJob.txt | 5 +- ...eJobs-getSharedClusterBackupRestoreJob.txt | 5 +- ...obs-listSharedClusterBackupRestoreJobs.txt | 5 +- .../atlas-api-sharedTierRestoreJobs.txt | 13 +-- ...rSnapshots-downloadSharedClusterBackup.txt | 5 +- ...edTierSnapshots-getSharedClusterBackup.txt | 5 +- ...TierSnapshots-listSharedClusterBackups.txt | 5 +- .../command/atlas-api-sharedTierSnapshots.txt | 13 +-- ...api-streams-acceptVpcPeeringConnection.txt | 5 +- ...pi-streams-createPrivateLinkConnection.txt | 5 +- ...las-api-streams-createStreamConnection.txt | 5 +- ...atlas-api-streams-createStreamInstance.txt | 5 +- ...ateStreamInstanceWithSampleConnections.txt | 5 +- ...tlas-api-streams-createStreamProcessor.txt | 5 +- ...pi-streams-deletePrivateLinkConnection.txt | 5 +- ...las-api-streams-deleteStreamConnection.txt | 5 +- ...atlas-api-streams-deleteStreamInstance.txt | 5 +- ...tlas-api-streams-deleteStreamProcessor.txt | 5 +- ...api-streams-deleteVpcPeeringConnection.txt | 5 +- ...-streams-downloadStreamTenantAuditLogs.txt | 5 +- .../atlas-api-streams-getAccountDetails.txt | 5 +- ...streams-getActiveVpcPeeringConnections.txt | 5 +- ...s-api-streams-getPrivateLinkConnection.txt | 5 +- .../atlas-api-streams-getStreamConnection.txt | 5 +- .../atlas-api-streams-getStreamInstance.txt | 5 +- .../atlas-api-streams-getStreamProcessor.txt | 5 +- ...s-api-streams-getVpcPeeringConnections.txt | 5 +- ...api-streams-listPrivateLinkConnections.txt | 5 +- ...tlas-api-streams-listStreamConnections.txt | 5 +- .../atlas-api-streams-listStreamInstances.txt | 5 +- ...atlas-api-streams-listStreamProcessors.txt | 5 +- ...tlas-api-streams-modifyStreamProcessor.txt | 5 +- ...api-streams-rejectVpcPeeringConnection.txt | 5 +- ...atlas-api-streams-startStreamProcessor.txt | 5 +- ...s-api-streams-startStreamProcessorWith.txt | 5 +- .../atlas-api-streams-stopStreamProcessor.txt | 5 +- ...las-api-streams-updateStreamConnection.txt | 5 +- ...atlas-api-streams-updateStreamInstance.txt | 5 +- docs/command/atlas-api-streams.txt | 65 +++++------ .../atlas-api-teams-addAllTeamsToProject.txt | 5 +- docs/command/atlas-api-teams-addTeamUser.txt | 5 +- docs/command/atlas-api-teams-createTeam.txt | 5 +- docs/command/atlas-api-teams-deleteTeam.txt | 5 +- .../atlas-api-teams-getProjectTeam.txt | 5 +- docs/command/atlas-api-teams-getTeamById.txt | 5 +- .../command/atlas-api-teams-getTeamByName.txt | 5 +- .../atlas-api-teams-listOrganizationTeams.txt | 5 +- .../atlas-api-teams-listProjectTeams.txt | 5 +- .../atlas-api-teams-removeProjectTeam.txt | 5 +- .../atlas-api-teams-removeTeamUser.txt | 5 +- docs/command/atlas-api-teams-renameTeam.txt | 5 +- .../atlas-api-teams-updateTeamRoles.txt | 5 +- docs/command/atlas-api-teams.txt | 33 +++--- ...tegrations-createThirdPartyIntegration.txt | 5 +- ...tegrations-deleteThirdPartyIntegration.txt | 5 +- ...yIntegrations-getThirdPartyIntegration.txt | 5 +- ...ntegrations-listThirdPartyIntegrations.txt | 5 +- ...tegrations-updateThirdPartyIntegration.txt | 5 +- .../atlas-api-thirdPartyIntegrations.txt | 15 +-- ...tication-createDatabaseUserCertificate.txt | 5 +- ...hentication-disableCustomerManagedX509.txt | 5 +- ...ntication-listDatabaseUserCertificates.txt | 5 +- docs/command/atlas-api-x509Authentication.txt | 11 +- docs/command/atlas-api.txt | 107 +++++++++--------- docs/command/atlas.txt | 2 +- 494 files changed, 986 insertions(+), 2509 deletions(-) diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt index e4fd0badd0..8174796bff 100644 --- a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt +++ b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt @@ -12,10 +12,7 @@ atlas api accessTracking listAccessLogsByClusterName :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the access logs of one cluster identified by the cluster's name. - -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. +Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt index 23929130e9..406f1f3074 100644 --- a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt +++ b/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt @@ -12,10 +12,7 @@ atlas api accessTracking listAccessLogsByHostname :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the access logs of one cluster identified by the cluster's hostname. - -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. +Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-accessTracking.txt b/docs/command/atlas-api-accessTracking.txt index 68e725ffd7..141468e29c 100644 --- a/docs/command/atlas-api-accessTracking.txt +++ b/docs/command/atlas-api-accessTracking.txt @@ -12,10 +12,7 @@ atlas api accessTracking :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns access logs for authentication attempts made to Atlas database deployments. - -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. +Returns access logs for authentication attempts made to Atlas database deployments. To view database access history, you must have either the Project Owner or Organization Owner role. @@ -54,8 +51,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - `Public Preview: please provide feedback `_: Returns the access logs of one cluster identified by the cluster's name. -* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - `Public Preview: please provide feedback `_: Returns the access logs of one cluster identified by the cluster's hostname. +* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - Returns the access logs of one cluster identified by the cluster's name. +* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - Returns the access logs of one cluster identified by the cluster's hostname. .. toctree:: diff --git a/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt index 53e5b47fc1..213264c4a6 100644 --- a/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt @@ -12,10 +12,7 @@ atlas api alertConfigurations createAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one alert configuration for the specified project. - -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. +Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. diff --git a/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt index 44e11138f1..5a2cfe54f7 100644 --- a/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt @@ -12,10 +12,7 @@ atlas api alertConfigurations deleteAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one alert configuration from the specified project. - -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. +Removes one alert configuration from the specified project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. diff --git a/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt index 6f2c38be7a..573a3e91e4 100644 --- a/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt @@ -12,10 +12,7 @@ atlas api alertConfigurations getAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the specified alert configuration from the specified project. - -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. +Returns the specified alert configuration from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt index 7e15c686b3..70e41e754b 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt @@ -12,10 +12,7 @@ atlas api alertConfigurations listAlertConfigurationMatchersFieldNames :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. - -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. +Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. You can successfully call this endpoint with any assigned role. diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt index ba26f6986d..e59af1e498 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt @@ -12,10 +12,7 @@ atlas api alertConfigurations listAlertConfigurations :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all alert configurations for one project. - -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. +Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt index d4a76aa046..5e712ef327 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt @@ -12,10 +12,7 @@ atlas api alertConfigurations listAlertConfigurationsByAlertId :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all alert configurations set for the specified alert. - -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. +Returns all alert configurations set for the specified alert. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. diff --git a/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt index fca89ddbff..6c76d1d740 100644 --- a/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt @@ -12,10 +12,7 @@ atlas api alertConfigurations toggleAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Enables or disables the specified alert configuration in the specified project. - -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. +Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. diff --git a/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt index 68f9f9ed1b..fa669bc440 100644 --- a/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt @@ -12,10 +12,7 @@ atlas api alertConfigurations updateAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one alert configuration in the specified project. - -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. +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. diff --git a/docs/command/atlas-api-alertConfigurations.txt b/docs/command/atlas-api-alertConfigurations.txt index 4dc2b34377..10e906633d 100644 --- a/docs/command/atlas-api-alertConfigurations.txt +++ b/docs/command/atlas-api-alertConfigurations.txt @@ -12,10 +12,7 @@ atlas api alertConfigurations :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. - -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. +Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change. @@ -54,14 +51,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - `Public Preview: please provide feedback `_: Creates one alert configuration for the specified project. -* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - `Public Preview: please provide feedback `_: Removes one alert configuration from the specified project. -* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - `Public Preview: please provide feedback `_: Returns the specified alert configuration from the specified project. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - `Public Preview: please provide feedback `_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - `Public Preview: please provide feedback `_: Returns all alert configurations for one project. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - `Public Preview: please provide feedback `_: Returns all alert configurations set for the specified alert. -* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - `Public Preview: please provide feedback `_: Enables or disables the specified alert configuration in the specified project. -* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - `Public Preview: please provide feedback `_: Updates one alert configuration in the specified project. +* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - Creates one alert configuration for the specified project. +* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - Removes one alert configuration from the specified project. +* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - Returns the specified alert configuration from the specified project. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - Returns all alert configurations for one project. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - Returns all alert configurations set for the specified alert. +* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - Enables or disables the specified alert configuration in the specified project. +* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - Updates one alert configuration in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-alerts-acknowledgeAlert.txt b/docs/command/atlas-api-alerts-acknowledgeAlert.txt index 9c0d165150..d92f59c1d2 100644 --- a/docs/command/atlas-api-alerts-acknowledgeAlert.txt +++ b/docs/command/atlas-api-alerts-acknowledgeAlert.txt @@ -12,10 +12,7 @@ atlas api alerts acknowledgeAlert :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Confirms receipt of one existing alert. - -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. +Confirms receipt of one existing alert. This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. diff --git a/docs/command/atlas-api-alerts-getAlert.txt b/docs/command/atlas-api-alerts-getAlert.txt index d4220dac65..e6e2553be3 100644 --- a/docs/command/atlas-api-alerts-getAlert.txt +++ b/docs/command/atlas-api-alerts-getAlert.txt @@ -12,10 +12,7 @@ atlas api alerts getAlert :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one alert. - -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. +Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. diff --git a/docs/command/atlas-api-alerts-listAlerts.txt b/docs/command/atlas-api-alerts-listAlerts.txt index 2033467828..308f922521 100644 --- a/docs/command/atlas-api-alerts-listAlerts.txt +++ b/docs/command/atlas-api-alerts-listAlerts.txt @@ -12,10 +12,7 @@ atlas api alerts listAlerts :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all alerts. - -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. +Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt b/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt index 369a4c0bdd..55172b7ed3 100644 --- a/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt +++ b/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt @@ -12,10 +12,7 @@ atlas api alerts listAlertsByAlertConfigurationId :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all open alerts that the specified alert configuration triggers. - -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. +Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. diff --git a/docs/command/atlas-api-alerts.txt b/docs/command/atlas-api-alerts.txt index ceaa4a22b1..a0203f50b3 100644 --- a/docs/command/atlas-api-alerts.txt +++ b/docs/command/atlas-api-alerts.txt @@ -12,10 +12,7 @@ atlas api alerts :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. - -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. +Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change. @@ -54,10 +51,10 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alerts-acknowledgeAlert` - `Public Preview: please provide feedback `_: Confirms receipt of one existing alert. -* :ref:`atlas-api-alerts-getAlert` - `Public Preview: please provide feedback `_: Returns one alert. -* :ref:`atlas-api-alerts-listAlerts` - `Public Preview: please provide feedback `_: Returns all alerts. -* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - `Public Preview: please provide feedback `_: Returns all open alerts that the specified alert configuration triggers. +* :ref:`atlas-api-alerts-acknowledgeAlert` - Confirms receipt of one existing alert. +* :ref:`atlas-api-alerts-getAlert` - Returns one alert. +* :ref:`atlas-api-alerts-listAlerts` - Returns all alerts. +* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - Returns all open alerts that the specified alert configuration triggers. .. toctree:: diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt index 8b7f0c4de4..531e1ba68b 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt @@ -12,10 +12,7 @@ atlas api atlasSearch createAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates Search Nodes for the specified cluster. - -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. +Creates Search Nodes for the specified cluster. 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-createatlassearchdeployment. diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt index 37fe0bcba8..1cbd58b482 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt @@ -12,10 +12,7 @@ atlas api atlasSearch createAtlasSearchIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one Atlas Search index on the specified collection. - -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. +Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt index e76e3e63eb..b04d90a93e 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt @@ -12,10 +12,7 @@ atlas api atlasSearch createAtlasSearchIndexDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one Atlas Search index on the specified collection. - -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. +Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt index 7c37646cfe..7b7cc8d6a6 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt @@ -12,10 +12,7 @@ atlas api atlasSearch deleteAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes the Search Nodes for the specified cluster. - -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. +Deletes the Search Nodes for the specified cluster. 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-deleteatlassearchdeployment. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt index e18cf884ae..dea490521c 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt @@ -12,10 +12,7 @@ atlas api atlasSearch deleteAtlasSearchIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one Atlas Search index that you identified with its unique ID. - -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. +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. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt index 529fd65db1..b1c4b11529 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt @@ -12,10 +12,7 @@ atlas api atlasSearch deleteAtlasSearchIndexByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one Atlas Search index that you identified with its database, collection, and name. - -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. +Removes one Atlas Search index that you identified with its database, collection, and name. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt index 6e7e94436d..d022eed0f0 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt @@ -12,10 +12,7 @@ atlas api atlasSearch deleteAtlasSearchIndexDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one Atlas Search index that you identified with its unique ID. - -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. +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. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt index 551d496121..00231d9aaa 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt @@ -12,10 +12,7 @@ atlas api atlasSearch getAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the Search Nodes for the specified cluster. - -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. +Returns the Search Nodes for the specified cluster. 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-getatlassearchdeployment. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt index 4e24895c23..dadcf6f3ff 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt @@ -12,10 +12,7 @@ atlas api atlasSearch getAtlasSearchIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one Atlas Search index that you identified with its unique ID. - -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. +Returns one Atlas Search index that you identified with its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt index 80d70bdd49..5eaadcd6fb 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt @@ -12,10 +12,7 @@ atlas api atlasSearch getAtlasSearchIndexByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one Atlas Search index that you identified with its database, collection name, and index name. - -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. +Returns one Atlas Search index that you identified with its database, collection name, and index name. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt index 2acba5b882..900000bca9 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt @@ -12,10 +12,7 @@ atlas api atlasSearch getAtlasSearchIndexDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one Atlas Search index in the specified project. - -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. +Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt index 8cfdca193c..feb8fec8b2 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt @@ -12,10 +12,7 @@ atlas api atlasSearch listAtlasSearchIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified collection. - -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. +Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt index f8a8899f52..217ce05fec 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt @@ -12,10 +12,7 @@ atlas api atlasSearch listAtlasSearchIndexesCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified cluster. - -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. +Returns all Atlas Search indexes on the specified cluster. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt index 031e07c694..8de069c38e 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt @@ -12,10 +12,7 @@ atlas api atlasSearch listAtlasSearchIndexesDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified collection. - -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. +Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt index 01e7b5a2f9..751b8d5dde 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt @@ -12,10 +12,7 @@ atlas api atlasSearch updateAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the Search Nodes for the specified cluster. - -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. +Updates the Search Nodes for the specified cluster. 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-updateatlassearchdeployment. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt index b096c6dfbf..b4cb0ed538 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt @@ -12,10 +12,7 @@ atlas api atlasSearch updateAtlasSearchIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one Atlas Search index that you identified with its unique ID. - -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. +Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt index 07dfdad1b6..c13926a77c 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt @@ -12,10 +12,7 @@ atlas api atlasSearch updateAtlasSearchIndexByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one Atlas Search index that you identified with its database, collection name, and index name. - -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. +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. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt index fa2ab9bd32..9afc1fe9f3 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt @@ -12,10 +12,7 @@ atlas api atlasSearch updateAtlasSearchIndexDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one Atlas Search index that you identified with its unique ID. - -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. +Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-atlasSearch.txt b/docs/command/atlas-api-atlasSearch.txt index bb650c3628..bede8c5aed 100644 --- a/docs/command/atlas-api-atlasSearch.txt +++ b/docs/command/atlas-api-atlasSearch.txt @@ -12,10 +12,7 @@ atlas api atlasSearch :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. - -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. +Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. Also returns and updates user-defined analyzers for the specified cluster. @@ -54,24 +51,24 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-atlasSearch-createAtlasSearchDeployment` - `Public Preview: please provide feedback `_: Creates Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-createAtlasSearchIndex` - `Public Preview: please provide feedback `_: Creates one Atlas Search index on the specified collection. -* :ref:`atlas-api-atlasSearch-createAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback `_: Creates one Atlas Search index on the specified collection. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchDeployment` - `Public Preview: please provide feedback `_: Deletes the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndex` - `Public Preview: please provide feedback `_: Removes one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexByName` - `Public Preview: please provide feedback `_: Removes one Atlas Search index that you identified with its database, collection, and name. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback `_: Removes one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-getAtlasSearchDeployment` - `Public Preview: please provide feedback `_: Returns the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndex` - `Public Preview: please provide feedback `_: Returns one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexByName` - `Public Preview: please provide feedback `_: Returns one Atlas Search index that you identified with its database, collection name, and index name. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback `_: Returns one Atlas Search index in the specified project. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexes` - `Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified collection. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesCluster` - `Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified cluster. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated` - `Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified collection. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchDeployment` - `Public Preview: please provide feedback `_: Updates the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndex` - `Public Preview: please provide feedback `_: Updates one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexByName` - `Public Preview: please provide feedback `_: Updates one Atlas Search index that you identified with its database, collection name, and index name. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback `_: Updates one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-createAtlasSearchDeployment` - Creates Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-createAtlasSearchIndex` - Creates one Atlas Search index on the specified collection. +* :ref:`atlas-api-atlasSearch-createAtlasSearchIndexDeprecated` - Creates one Atlas Search index on the specified collection. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchDeployment` - Deletes the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndex` - Removes one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexByName` - Removes one Atlas Search index that you identified with its database, collection, and name. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated` - Removes one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-getAtlasSearchDeployment` - Returns the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndex` - Returns one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexByName` - Returns one Atlas Search index that you identified with its database, collection name, and index name. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexDeprecated` - Returns one Atlas Search index in the specified project. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexes` - Returns all Atlas Search indexes on the specified collection. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesCluster` - Returns all Atlas Search indexes on the specified cluster. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated` - Returns all Atlas Search indexes on the specified collection. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchDeployment` - Updates the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndex` - Updates one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexByName` - Updates one Atlas Search index that you identified with its database, collection name, and index name. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated` - Updates one Atlas Search index that you identified with its unique ID. .. toctree:: diff --git a/docs/command/atlas-api-auditing-getAuditingConfiguration.txt b/docs/command/atlas-api-auditing-getAuditingConfiguration.txt index e860e9bd78..2330eb7a6d 100644 --- a/docs/command/atlas-api-auditing-getAuditingConfiguration.txt +++ b/docs/command/atlas-api-auditing-getAuditingConfiguration.txt @@ -12,10 +12,7 @@ atlas api auditing getAuditingConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the auditing configuration for the specified project. - -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. +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. diff --git a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt b/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt index 65f5cb25da..f083ed4d05 100644 --- a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt +++ b/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt @@ -12,10 +12,7 @@ atlas api auditing updateAuditingConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the auditing configuration for the specified project. - -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. +Updates the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. diff --git a/docs/command/atlas-api-auditing.txt b/docs/command/atlas-api-auditing.txt index 0cd3df8d11..64cabd3b04 100644 --- a/docs/command/atlas-api-auditing.txt +++ b/docs/command/atlas-api-auditing.txt @@ -12,12 +12,7 @@ atlas api auditing :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns and edits database auditing settings for MongoDB Cloud projects. - -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. - - +Returns and edits database auditing settings for MongoDB Cloud projects. Options ------- @@ -54,8 +49,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-auditing-getAuditingConfiguration` - `Public Preview: please provide feedback `_: Returns the auditing configuration for the specified project. -* :ref:`atlas-api-auditing-updateAuditingConfiguration` - `Public Preview: please provide feedback `_: Updates the auditing configuration for the specified project. +* :ref:`atlas-api-auditing-getAuditingConfiguration` - Returns the auditing configuration for the specified project. +* :ref:`atlas-api-auditing-updateAuditingConfiguration` - Updates the auditing configuration for the specified project. .. toctree:: diff --git a/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt b/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt index f91ceffec5..b5132b2718 100644 --- a/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt +++ b/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt @@ -12,10 +12,7 @@ atlas api awsClustersDns getAwsCustomDns :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the custom DNS configuration for AWS clusters in the specified project. - -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. +Returns the custom DNS configuration for AWS clusters in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt index b873f60300..6b14069cba 100644 --- a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt +++ b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt @@ -12,10 +12,7 @@ atlas api awsClustersDns toggleAwsCustomDns :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Enables or disables the custom DNS configuration for AWS clusters in the specified project. - -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. +Enables or disables the custom DNS configuration for AWS clusters in the specified project. Enable custom DNS if you use AWS VPC peering and use your own DNS servers. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. diff --git a/docs/command/atlas-api-awsClustersDns.txt b/docs/command/atlas-api-awsClustersDns.txt index 025ed45180..9cfff03a75 100644 --- a/docs/command/atlas-api-awsClustersDns.txt +++ b/docs/command/atlas-api-awsClustersDns.txt @@ -12,10 +12,7 @@ atlas api awsClustersDns :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. - -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. +Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. The resource requires your Project ID. If you use the VPC peering on AWS and you use your own DNS servers instead of Amazon Route 53, enable custom DNS. Before 31 March 2020, applications deployed within AWS using custom DNS services and VPC-peered with MongoDB Cloud couldn't connect over private IP addresses. Custom DNS resolved to public IP addresses. AWS internal DNS resolved to private IP addresses. Applications deployed with custom DNS services in AWS should use Private IP for Peering connection strings. @@ -54,8 +51,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-awsClustersDns-getAwsCustomDns` - `Public Preview: please provide feedback `_: Returns the custom DNS configuration for AWS clusters in the specified project. -* :ref:`atlas-api-awsClustersDns-toggleAwsCustomDns` - `Public Preview: please provide feedback `_: Enables or disables the custom DNS configuration for AWS clusters in the specified project. +* :ref:`atlas-api-awsClustersDns-getAwsCustomDns` - Returns the custom DNS configuration for AWS clusters in the specified project. +* :ref:`atlas-api-awsClustersDns-toggleAwsCustomDns` - Enables or disables the custom DNS configuration for AWS clusters in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt index fd68659f5c..69e53c5b35 100644 --- a/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt @@ -12,10 +12,7 @@ atlas api cloudBackups cancelBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Cancels one cloud backup restore job of one cluster from the specified project. - -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. +Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt index 4e5ee99f7f..c8ef224323 100644 --- a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt +++ b/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt @@ -12,10 +12,7 @@ atlas api cloudBackups createBackupExportJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. - -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. +Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. diff --git a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt index 1dac6b3903..729d2cb62b 100644 --- a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt @@ -12,10 +12,7 @@ atlas api cloudBackups createBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Restores one snapshot of one cluster from the specified project. - -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. +Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. diff --git a/docs/command/atlas-api-cloudBackups-createExportBucket.txt b/docs/command/atlas-api-cloudBackups-createExportBucket.txt index afd330ae35..106b01b022 100644 --- a/docs/command/atlas-api-cloudBackups-createExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-createExportBucket.txt @@ -12,10 +12,7 @@ atlas api cloudBackups createExportBucket :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. - -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. +Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt index 3748ff9b06..3d88f5f3f3 100644 --- a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt @@ -12,10 +12,7 @@ atlas api cloudBackups createServerlessBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Restores one snapshot of one serverless instance from the specified project. - -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. +Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt b/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt index 937c7c05e2..5fd8cf71c5 100644 --- a/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt +++ b/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt @@ -12,10 +12,7 @@ atlas api cloudBackups deleteAllBackupSchedules :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes all cloud backup schedules for the specified cluster. - -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. +Removes all cloud backup schedules for the specified cluster. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. diff --git a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt index 3aff0065e1..105cef8633 100644 --- a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt @@ -12,10 +12,7 @@ atlas api cloudBackups deleteExportBucket :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes an Export Bucket. - -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. +Deletes an Export Bucket. Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt index 854537ab91..03a301aedb 100644 --- a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt +++ b/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt @@ -12,10 +12,7 @@ atlas api cloudBackups deleteReplicaSetBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes the specified snapshot. - -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. +Removes the specified snapshot. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt index 01f2edb5e7..82e88ddf00 100644 --- a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt +++ b/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt @@ -12,10 +12,7 @@ atlas api cloudBackups deleteShardedClusterBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one snapshot of one sharded cluster from the specified project. - -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. +Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt index 82c05fd0dd..ba85cd2dcc 100644 --- a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt @@ -12,10 +12,7 @@ atlas api cloudBackups disableDataProtectionSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Disables the Backup Compliance Policy settings with the specified project. - -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. +Disables the Backup Compliance Policy settings with the specified project. As a prerequisite, a support ticket needs to be file first, instructions in https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt index 3d90c9c923..b6a95fb081 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt @@ -12,10 +12,7 @@ atlas api cloudBackups getBackupExportJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. - -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. +Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. diff --git a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt index 861d7e6760..17563d7443 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt @@ -12,10 +12,7 @@ atlas api cloudBackups getBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one cloud backup restore job for one cluster from the specified project. - -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. +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. diff --git a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt index 7795a2a261..6f4e10da74 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt @@ -12,10 +12,7 @@ atlas api cloudBackups getBackupSchedule :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the cloud backup schedule for the specified cluster within the specified project. - -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. +Returns the cloud backup schedule for the specified cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt index 83619024ed..a08cb60027 100644 --- a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt @@ -12,10 +12,7 @@ atlas api cloudBackups getDataProtectionSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the Backup Compliance Policy settings with the specified project. - -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. +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. diff --git a/docs/command/atlas-api-cloudBackups-getExportBucket.txt b/docs/command/atlas-api-cloudBackups-getExportBucket.txt index 868a275e3a..78c90e9384 100644 --- a/docs/command/atlas-api-cloudBackups-getExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-getExportBucket.txt @@ -12,10 +12,7 @@ atlas api cloudBackups getExportBucket :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one Export Bucket associated with the specified Project. - -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. +Returns one Export Bucket associated with the specified Project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt index dafbaf3368..cc082bcb73 100644 --- a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt @@ -12,10 +12,7 @@ atlas api cloudBackups getReplicaSetBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one snapshot from the specified cluster. - -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. +Returns one snapshot from the specified cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt index 72af10a289..56be34a6a4 100644 --- a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt @@ -12,10 +12,7 @@ atlas api cloudBackups getServerlessBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one snapshot of one serverless instance from the specified project. - -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. +Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt index cc3a8eb1bc..30037495b0 100644 --- a/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt @@ -12,10 +12,7 @@ atlas api cloudBackups getServerlessBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one restore job for one serverless instance from the specified project. - -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. +Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt index 71f5ee1eea..24e86e97d1 100644 --- a/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt @@ -12,10 +12,7 @@ atlas api cloudBackups getShardedClusterBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one snapshot of one sharded cluster from the specified project. - -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. +Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt index 52201dd823..9ca305b003 100644 --- a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt @@ -12,10 +12,7 @@ atlas api cloudBackups listBackupExportJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. - -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. +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. diff --git a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt index a5b2798ba0..a670c5f112 100644 --- a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt @@ -12,10 +12,7 @@ atlas api cloudBackups listBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all cloud backup restore jobs for one cluster from the specified project. - -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. +Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt index 121b6b9af0..766eeed0db 100644 --- a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt +++ b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt @@ -12,10 +12,7 @@ atlas api cloudBackups listExportBuckets :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all Export Buckets associated with the specified Project. - -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. +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. diff --git a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt b/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt index 7a12e2f0e6..e5dcca7987 100644 --- a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt @@ -12,10 +12,7 @@ atlas api cloudBackups listReplicaSetBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all snapshots of one cluster from the specified project. - -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. +Returns all snapshots of one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt index c024b09ca8..4cdbedc112 100644 --- a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt @@ -12,10 +12,7 @@ atlas api cloudBackups listServerlessBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all restore jobs for one serverless instance from the specified project. - -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. +Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt index 9d53431410..a2e3658e36 100644 --- a/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt @@ -12,10 +12,7 @@ atlas api cloudBackups listServerlessBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all snapshots of one serverless instance from the specified project. - -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. +Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt b/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt index 3678723bd4..98c8ed1d64 100644 --- a/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt @@ -12,10 +12,7 @@ atlas api cloudBackups listShardedClusterBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all snapshots of one sharded cluster from the specified project. - -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. +Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt b/docs/command/atlas-api-cloudBackups-takeSnapshot.txt index 3eebc51358..3f7e947b65 100644 --- a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt +++ b/docs/command/atlas-api-cloudBackups-takeSnapshot.txt @@ -12,10 +12,7 @@ atlas api cloudBackups takeSnapshot :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Takes one on-demand snapshot for the specified cluster. - -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. +Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. diff --git a/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt index 2d49672b13..17f5418a67 100644 --- a/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt +++ b/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt @@ -12,10 +12,7 @@ atlas api cloudBackups updateBackupSchedule :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the cloud backup schedule for one cluster within the specified project. - -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. +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. diff --git a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt index 48046b4020..534419a05a 100644 --- a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt @@ -12,10 +12,7 @@ atlas api cloudBackups updateDataProtectionSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the Backup Compliance Policy settings for the specified project. - -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. +Updates the Backup Compliance Policy settings for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt b/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt index 2966a0b12c..f3fbfd3b6a 100644 --- a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt +++ b/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt @@ -12,10 +12,7 @@ atlas api cloudBackups updateSnapshotRetention :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. - -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. +Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. The requesting API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups.txt b/docs/command/atlas-api-cloudBackups.txt index 8676164f20..e4eca8685f 100644 --- a/docs/command/atlas-api-cloudBackups.txt +++ b/docs/command/atlas-api-cloudBackups.txt @@ -12,10 +12,7 @@ atlas api cloudBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. - -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. +Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups. @@ -54,36 +51,36 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudBackups-cancelBackupRestoreJob` - `Public Preview: please provide feedback `_: Cancels one cloud backup restore job of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-createBackupExportJob` - `Public Preview: please provide feedback `_: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. -* :ref:`atlas-api-cloudBackups-createBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores one snapshot of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-createExportBucket` - `Public Preview: please provide feedback `_: Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. -* :ref:`atlas-api-cloudBackups-createServerlessBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores one snapshot of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-deleteAllBackupSchedules` - `Public Preview: please provide feedback `_: Removes all cloud backup schedules for the specified cluster. -* :ref:`atlas-api-cloudBackups-deleteExportBucket` - `Public Preview: please provide feedback `_: Deletes an Export Bucket. -* :ref:`atlas-api-cloudBackups-deleteReplicaSetBackup` - `Public Preview: please provide feedback `_: Removes the specified snapshot. -* :ref:`atlas-api-cloudBackups-deleteShardedClusterBackup` - `Public Preview: please provide feedback `_: Removes one snapshot of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-disableDataProtectionSettings` - `Public Preview: please provide feedback `_: Disables the Backup Compliance Policy settings with the specified project. -* :ref:`atlas-api-cloudBackups-getBackupExportJob` - `Public Preview: please provide feedback `_: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. -* :ref:`atlas-api-cloudBackups-getBackupRestoreJob` - `Public Preview: please provide feedback `_: Returns one cloud backup restore job for one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-getBackupSchedule` - `Public Preview: please provide feedback `_: Returns the cloud backup schedule for the specified cluster within the specified project. -* :ref:`atlas-api-cloudBackups-getDataProtectionSettings` - `Public Preview: please provide feedback `_: Returns the Backup Compliance Policy settings with the specified project. -* :ref:`atlas-api-cloudBackups-getExportBucket` - `Public Preview: please provide feedback `_: Returns one Export Bucket associated with the specified Project. -* :ref:`atlas-api-cloudBackups-getReplicaSetBackup` - `Public Preview: please provide feedback `_: Returns one snapshot from the specified cluster. -* :ref:`atlas-api-cloudBackups-getServerlessBackup` - `Public Preview: please provide feedback `_: Returns one snapshot of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-getServerlessBackupRestoreJob` - `Public Preview: please provide feedback `_: Returns one restore job for one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-getShardedClusterBackup` - `Public Preview: please provide feedback `_: Returns one snapshot of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listBackupExportJobs` - `Public Preview: please provide feedback `_: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. -* :ref:`atlas-api-cloudBackups-listBackupRestoreJobs` - `Public Preview: please provide feedback `_: Returns all cloud backup restore jobs for one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listExportBuckets` - `Public Preview: please provide feedback `_: Returns all Export Buckets associated with the specified Project. -* :ref:`atlas-api-cloudBackups-listReplicaSetBackups` - `Public Preview: please provide feedback `_: Returns all snapshots of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listServerlessBackupRestoreJobs` - `Public Preview: please provide feedback `_: Returns all restore jobs for one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-listServerlessBackups` - `Public Preview: please provide feedback `_: Returns all snapshots of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-listShardedClusterBackups` - `Public Preview: please provide feedback `_: Returns all snapshots of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-takeSnapshot` - `Public Preview: please provide feedback `_: Takes one on-demand snapshot for the specified cluster. -* :ref:`atlas-api-cloudBackups-updateBackupSchedule` - `Public Preview: please provide feedback `_: Updates the cloud backup schedule for one cluster within the specified project. -* :ref:`atlas-api-cloudBackups-updateDataProtectionSettings` - `Public Preview: please provide feedback `_: Updates the Backup Compliance Policy settings for the specified project. -* :ref:`atlas-api-cloudBackups-updateSnapshotRetention` - `Public Preview: please provide feedback `_: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-cloudBackups-cancelBackupRestoreJob` - Cancels one cloud backup restore job of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-createBackupExportJob` - Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. +* :ref:`atlas-api-cloudBackups-createBackupRestoreJob` - Restores one snapshot of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-createExportBucket` - Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. +* :ref:`atlas-api-cloudBackups-createServerlessBackupRestoreJob` - Restores one snapshot of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-deleteAllBackupSchedules` - Removes all cloud backup schedules for the specified cluster. +* :ref:`atlas-api-cloudBackups-deleteExportBucket` - Deletes an Export Bucket. +* :ref:`atlas-api-cloudBackups-deleteReplicaSetBackup` - Removes the specified snapshot. +* :ref:`atlas-api-cloudBackups-deleteShardedClusterBackup` - Removes one snapshot of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-disableDataProtectionSettings` - Disables the Backup Compliance Policy settings with the specified project. +* :ref:`atlas-api-cloudBackups-getBackupExportJob` - Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. +* :ref:`atlas-api-cloudBackups-getBackupRestoreJob` - Returns one cloud backup restore job for one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-getBackupSchedule` - Returns the cloud backup schedule for the specified cluster within the specified project. +* :ref:`atlas-api-cloudBackups-getDataProtectionSettings` - Returns the Backup Compliance Policy settings with the specified project. +* :ref:`atlas-api-cloudBackups-getExportBucket` - Returns one Export Bucket associated with the specified Project. +* :ref:`atlas-api-cloudBackups-getReplicaSetBackup` - Returns one snapshot from the specified cluster. +* :ref:`atlas-api-cloudBackups-getServerlessBackup` - Returns one snapshot of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-getServerlessBackupRestoreJob` - Returns one restore job for one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-getShardedClusterBackup` - Returns one snapshot of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listBackupExportJobs` - Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. +* :ref:`atlas-api-cloudBackups-listBackupRestoreJobs` - Returns all cloud backup restore jobs for one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listExportBuckets` - Returns all Export Buckets associated with the specified Project. +* :ref:`atlas-api-cloudBackups-listReplicaSetBackups` - Returns all snapshots of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listServerlessBackupRestoreJobs` - Returns all restore jobs for one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-listServerlessBackups` - Returns all snapshots of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-listShardedClusterBackups` - Returns all snapshots of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-takeSnapshot` - Takes one on-demand snapshot for the specified cluster. +* :ref:`atlas-api-cloudBackups-updateBackupSchedule` - Updates the cloud backup schedule for one cluster within the specified project. +* :ref:`atlas-api-cloudBackups-updateDataProtectionSettings` - Updates the Backup Compliance Policy settings for the specified project. +* :ref:`atlas-api-cloudBackups-updateSnapshotRetention` - Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt b/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt index c1c362ad3d..04803b3074 100644 --- a/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt +++ b/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt @@ -12,10 +12,7 @@ atlas api cloudMigrationService createLinkToken :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Create one link-token that contains all the information required to complete the link. - -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. +Create one link-token that contains all the information required to complete the link. MongoDB Atlas uses the link-token for push live migrations only. Live migration (push) allows you to securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. diff --git a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt index 35d0382e0a..99e2459cad 100644 --- a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt @@ -12,10 +12,7 @@ atlas api cloudMigrationService createPushMigration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. - -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. +Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. Please make sure to validate your migration before initiating it. diff --git a/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt b/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt index fc47a63982..dec9511271 100644 --- a/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt @@ -12,10 +12,7 @@ atlas api cloudMigrationService cutoverMigration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Cut over the migrated cluster to MongoDB Atlas. - -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. +Cut over the migrated cluster to MongoDB Atlas. Confirm when the cut over completes. When the cut over completes, MongoDB Atlas completes the live migration process and stops synchronizing with the source cluster. Your API Key must have the Organization Owner role to successfully call this resource. diff --git a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt b/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt index e56f8ff7c1..bf9692726e 100644 --- a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt +++ b/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt @@ -12,10 +12,7 @@ atlas api cloudMigrationService deleteLinkToken :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Remove one organization link and its associated public API key. - -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. +Remove one organization link and its associated public API key. MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. diff --git a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt index 9f0731e3b4..565a0112e0 100644 --- a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt @@ -12,10 +12,7 @@ atlas api cloudMigrationService getPushMigration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Return details of one cluster migration job. - -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. +Return details of one cluster migration job. Each push live migration job uses one migration host. Your API Key must have the Organization Member role to successfully call this resource. diff --git a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt b/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt index 3ec67f200c..8ccb9ede96 100644 --- a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt +++ b/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt @@ -12,10 +12,7 @@ atlas api cloudMigrationService getValidationStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Return the status of one migration validation job. - -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. +Return the status of one migration validation job. Your API Key must have the Organization Owner role to successfully call this resource. diff --git a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt b/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt index 7451741383..1d23a6a1ea 100644 --- a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt +++ b/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt @@ -12,10 +12,7 @@ atlas api cloudMigrationService listSourceProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Return all projects that you can migrate to the specified organization. - -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. +Return all projects that you can migrate to the specified organization. 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-listsourceprojects. diff --git a/docs/command/atlas-api-cloudMigrationService-validateMigration.txt b/docs/command/atlas-api-cloudMigrationService-validateMigration.txt index c9e78c36ed..baad21ea84 100644 --- a/docs/command/atlas-api-cloudMigrationService-validateMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-validateMigration.txt @@ -12,10 +12,7 @@ atlas api cloudMigrationService validateMigration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. - -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. +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. diff --git a/docs/command/atlas-api-cloudMigrationService.txt b/docs/command/atlas-api-cloudMigrationService.txt index 07f47eba6c..338eec7c3a 100644 --- a/docs/command/atlas-api-cloudMigrationService.txt +++ b/docs/command/atlas-api-cloudMigrationService.txt @@ -12,10 +12,7 @@ atlas api cloudMigrationService :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Manages the Cloud Migration Service. - -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. +Manages the Cloud Migration Service. Source organizations, projects, and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations, projects, and MongoDB clusters reside on MongoDB Cloud. Source databases can't use any authentication except SCRAM-SHA. @@ -54,14 +51,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudMigrationService-createLinkToken` - `Public Preview: please provide feedback `_: Create one link-token that contains all the information required to complete the link. -* :ref:`atlas-api-cloudMigrationService-createPushMigration` - `Public Preview: please provide feedback `_: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. -* :ref:`atlas-api-cloudMigrationService-cutoverMigration` - `Public Preview: please provide feedback `_: Cut over the migrated cluster to MongoDB Atlas. -* :ref:`atlas-api-cloudMigrationService-deleteLinkToken` - `Public Preview: please provide feedback `_: Remove one organization link and its associated public API key. -* :ref:`atlas-api-cloudMigrationService-getPushMigration` - `Public Preview: please provide feedback `_: Return details of one cluster migration job. -* :ref:`atlas-api-cloudMigrationService-getValidationStatus` - `Public Preview: please provide feedback `_: Return the status of one migration validation job. -* :ref:`atlas-api-cloudMigrationService-listSourceProjects` - `Public Preview: please provide feedback `_: Return all projects that you can migrate to the specified organization. -* :ref:`atlas-api-cloudMigrationService-validateMigration` - `Public Preview: please provide feedback `_: Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. +* :ref:`atlas-api-cloudMigrationService-createLinkToken` - Create one link-token that contains all the information required to complete the link. +* :ref:`atlas-api-cloudMigrationService-createPushMigration` - Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. +* :ref:`atlas-api-cloudMigrationService-cutoverMigration` - Cut over the migrated cluster to MongoDB Atlas. +* :ref:`atlas-api-cloudMigrationService-deleteLinkToken` - Remove one organization link and its associated public API key. +* :ref:`atlas-api-cloudMigrationService-getPushMigration` - Return details of one cluster migration job. +* :ref:`atlas-api-cloudMigrationService-getValidationStatus` - Return the status of one migration validation job. +* :ref:`atlas-api-cloudMigrationService-listSourceProjects` - Return all projects that you can migrate to the specified organization. +* :ref:`atlas-api-cloudMigrationService-validateMigration` - Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. .. toctree:: diff --git a/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt index eb3b85417f..523e607ab2 100644 --- a/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt @@ -12,10 +12,7 @@ atlas api cloudProviderAccess authorizeCloudProviderAccessRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Grants access to the specified project for the specified access role. - -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. +Grants access to the specified project for the specified access role. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. This is not required for GCP service account access. diff --git a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt index ddf1e93947..e2d533aa13 100644 --- a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt @@ -12,10 +12,7 @@ atlas api cloudProviderAccess createCloudProviderAccessRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one access role for the specified cloud provider. - -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. +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. diff --git a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt index 2bf570e133..5d2221e6dd 100644 --- a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt @@ -12,10 +12,7 @@ atlas api cloudProviderAccess deauthorizeCloudProviderAccessRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Revokes access to the specified project for the specified access role. - -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. +Revokes access to the specified project for the specified access role. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt index cfef189067..6a2219699b 100644 --- a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt @@ -12,10 +12,7 @@ atlas api cloudProviderAccess getCloudProviderAccessRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the access role with the specified id and with access to the specified project. - -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. +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. diff --git a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt index 2f377a18db..375aff1703 100644 --- a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt +++ b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt @@ -12,10 +12,7 @@ atlas api cloudProviderAccess listCloudProviderAccessRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all cloud provider access roles with access to the specified project. - -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. +Returns all cloud provider access roles with access to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudProviderAccess.txt b/docs/command/atlas-api-cloudProviderAccess.txt index 3076e1ccfb..a22dbd2df1 100644 --- a/docs/command/atlas-api-cloudProviderAccess.txt +++ b/docs/command/atlas-api-cloudProviderAccess.txt @@ -12,12 +12,7 @@ atlas api cloudProviderAccess :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. - -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. - - +Returns, adds, authorizes, and removes AWS IAM roles in Atlas. Options ------- @@ -54,11 +49,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole` - `Public Preview: please provide feedback `_: Grants access to the specified project for the specified access role. -* :ref:`atlas-api-cloudProviderAccess-createCloudProviderAccessRole` - `Public Preview: please provide feedback `_: Creates one access role for the specified cloud provider. -* :ref:`atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole` - `Public Preview: please provide feedback `_: Revokes access to the specified project for the specified access role. -* :ref:`atlas-api-cloudProviderAccess-getCloudProviderAccessRole` - `Public Preview: please provide feedback `_: Returns the access role with the specified id and with access to the specified project. -* :ref:`atlas-api-cloudProviderAccess-listCloudProviderAccessRoles` - `Public Preview: please provide feedback `_: Returns all cloud provider access roles with access to the specified project. +* :ref:`atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole` - Grants access to the specified project for the specified access role. +* :ref:`atlas-api-cloudProviderAccess-createCloudProviderAccessRole` - Creates one access role for the specified cloud provider. +* :ref:`atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole` - Revokes access to the specified project for the specified access role. +* :ref:`atlas-api-cloudProviderAccess-getCloudProviderAccessRole` - Returns the access role with the specified id and with access to the specified project. +* :ref:`atlas-api-cloudProviderAccess-listCloudProviderAccessRoles` - Returns all cloud provider access roles with access to the specified project. .. toctree:: diff --git a/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt index dff06016d5..0454b4ed8c 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt @@ -12,10 +12,7 @@ atlas api clusterOutageSimulation endOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Ends a cluster outage simulation. - -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. +Ends a cluster outage simulation. 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-endoutagesimulation. diff --git a/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt index f91a74a59f..34d41160aa 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt @@ -12,10 +12,7 @@ atlas api clusterOutageSimulation getOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one outage simulation for one cluster. - -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. +Returns one outage simulation for one cluster. 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-getoutagesimulation. diff --git a/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt index 608c8efd7e..26e435c46f 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt @@ -12,10 +12,7 @@ atlas api clusterOutageSimulation startOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Starts a cluster outage simulation. - -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. +Starts a cluster outage simulation. 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-startoutagesimulation. diff --git a/docs/command/atlas-api-clusterOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation.txt index 5cd64160be..18624d4d62 100644 --- a/docs/command/atlas-api-clusterOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation.txt @@ -12,12 +12,7 @@ atlas api clusterOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, starts, or ends a cluster outage simulation. - -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. - - +Returns, starts, or ends a cluster outage simulation. Options ------- @@ -54,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-clusterOutageSimulation-endOutageSimulation` - `Public Preview: please provide feedback `_: Ends a cluster outage simulation. -* :ref:`atlas-api-clusterOutageSimulation-getOutageSimulation` - `Public Preview: please provide feedback `_: Returns one outage simulation for one cluster. -* :ref:`atlas-api-clusterOutageSimulation-startOutageSimulation` - `Public Preview: please provide feedback `_: Starts a cluster outage simulation. +* :ref:`atlas-api-clusterOutageSimulation-endOutageSimulation` - Ends a cluster outage simulation. +* :ref:`atlas-api-clusterOutageSimulation-getOutageSimulation` - Returns one outage simulation for one cluster. +* :ref:`atlas-api-clusterOutageSimulation-startOutageSimulation` - Starts a cluster outage simulation. .. toctree:: diff --git a/docs/command/atlas-api-clusters-autoScalingConfiguration.txt b/docs/command/atlas-api-clusters-autoScalingConfiguration.txt index d236494c46..0729cfdd91 100644 --- a/docs/command/atlas-api-clusters-autoScalingConfiguration.txt +++ b/docs/command/atlas-api-clusters-autoScalingConfiguration.txt @@ -12,10 +12,7 @@ atlas api clusters autoScalingConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the internal configuration of AutoScaling for sharded clusters. - -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. +Returns the internal configuration of AutoScaling for sharded clusters. This endpoint can be used for diagnostic purposes to ensure that sharded clusters updated from older APIs have gained support for AutoScaling each shard independently. diff --git a/docs/command/atlas-api-clusters-createCluster.txt b/docs/command/atlas-api-clusters-createCluster.txt index 3f158b43eb..489063094d 100644 --- a/docs/command/atlas-api-clusters-createCluster.txt +++ b/docs/command/atlas-api-clusters-createCluster.txt @@ -12,10 +12,7 @@ atlas api clusters createCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one cluster in the specified project. - -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. +Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature is not available for serverless clusters. diff --git a/docs/command/atlas-api-clusters-deleteCluster.txt b/docs/command/atlas-api-clusters-deleteCluster.txt index 6d0e4338a8..663745784c 100644 --- a/docs/command/atlas-api-clusters-deleteCluster.txt +++ b/docs/command/atlas-api-clusters-deleteCluster.txt @@ -12,10 +12,7 @@ atlas api clusters deleteCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one cluster from the specified project. - -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. +Removes one cluster from the specified project. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature is not available for serverless clusters. diff --git a/docs/command/atlas-api-clusters-getCluster.txt b/docs/command/atlas-api-clusters-getCluster.txt index 970b1d81d9..4e692e1f0c 100644 --- a/docs/command/atlas-api-clusters-getCluster.txt +++ b/docs/command/atlas-api-clusters-getCluster.txt @@ -12,10 +12,7 @@ atlas api clusters getCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the details for one cluster in the specified project. - -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. +Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This feature is not available for serverless clusters. diff --git a/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt index 315a1342e3..b7b6c8b6c9 100644 --- a/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt +++ b/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt @@ -12,10 +12,7 @@ atlas api clusters getClusterAdvancedConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the advanced configuration details for one cluster in the specified project. - -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. +Returns the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-clusters-getClusterStatus.txt b/docs/command/atlas-api-clusters-getClusterStatus.txt index e12efec779..de110aaf70 100644 --- a/docs/command/atlas-api-clusters-getClusterStatus.txt +++ b/docs/command/atlas-api-clusters-getClusterStatus.txt @@ -12,10 +12,7 @@ atlas api clusters getClusterStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the status of all changes that you made to the specified cluster in the specified project. - -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. +Returns the status of all changes that you made to the specified cluster in the specified project. Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt b/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt index ffaa8948b4..e2ce139265 100644 --- a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt +++ b/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt @@ -12,10 +12,7 @@ atlas api clusters getSampleDatasetLoadStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Checks the progress of loading the sample dataset into one cluster. - -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. +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. diff --git a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt index 3b37fc1bb1..a166891731 100644 --- a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt +++ b/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt @@ -12,10 +12,7 @@ atlas api clusters grantMongoDbEmployeeAccess :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. - -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. +Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. 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-grantmongodbemployeeaccess. diff --git a/docs/command/atlas-api-clusters-listCloudProviderRegions.txt b/docs/command/atlas-api-clusters-listCloudProviderRegions.txt index 8b700284df..2c8ca89bbf 100644 --- a/docs/command/atlas-api-clusters-listCloudProviderRegions.txt +++ b/docs/command/atlas-api-clusters-listCloudProviderRegions.txt @@ -12,10 +12,7 @@ atlas api clusters listCloudProviderRegions :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the list of regions available for the specified cloud provider at the specified tier. - -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. +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. diff --git a/docs/command/atlas-api-clusters-listClusters.txt b/docs/command/atlas-api-clusters-listClusters.txt index 08481808b3..5b79a1d619 100644 --- a/docs/command/atlas-api-clusters-listClusters.txt +++ b/docs/command/atlas-api-clusters-listClusters.txt @@ -12,10 +12,7 @@ atlas api clusters listClusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the details for all clusters in the specific project to which you have access. - -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. +Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This feature is not available for serverless clusters. diff --git a/docs/command/atlas-api-clusters-listClustersForAllProjects.txt b/docs/command/atlas-api-clusters-listClustersForAllProjects.txt index 6364418c6b..901c2b2a4b 100644 --- a/docs/command/atlas-api-clusters-listClustersForAllProjects.txt +++ b/docs/command/atlas-api-clusters-listClustersForAllProjects.txt @@ -12,10 +12,7 @@ atlas api clusters listClustersForAllProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the details for all clusters in all projects to which you have access. - -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. +Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting Service Account or API Key can have any cluster-level role. diff --git a/docs/command/atlas-api-clusters-loadSampleDataset.txt b/docs/command/atlas-api-clusters-loadSampleDataset.txt index 039ca709e2..37b6305593 100644 --- a/docs/command/atlas-api-clusters-loadSampleDataset.txt +++ b/docs/command/atlas-api-clusters-loadSampleDataset.txt @@ -12,10 +12,7 @@ atlas api clusters loadSampleDataset :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Requests loading the MongoDB sample dataset into the specified cluster. - -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. +Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt index 6bc18e0042..2a6bce1e2e 100644 --- a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt +++ b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt @@ -12,10 +12,7 @@ atlas api clusters pinFeatureCompatibilityVersion :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. - -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. +Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. If an FCV pin already exists for the cluster, calling this method will only update the expiration date of the existing pin and will not repin the FCV. diff --git a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt index a0b8b03da4..3412f4a3f8 100644 --- a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt +++ b/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt @@ -12,10 +12,7 @@ atlas api clusters revokeMongoDbEmployeeAccess :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Revokes a previously granted MongoDB employee cluster access. - -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. +Revokes a previously granted MongoDB employee cluster access. 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-revokemongodbemployeeaccess. diff --git a/docs/command/atlas-api-clusters-testFailover.txt b/docs/command/atlas-api-clusters-testFailover.txt index f406c9df38..7182dbd2e0 100644 --- a/docs/command/atlas-api-clusters-testFailover.txt +++ b/docs/command/atlas-api-clusters-testFailover.txt @@ -12,10 +12,7 @@ atlas api clusters testFailover :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Starts a failover test for the specified cluster in the specified project. - -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. +Starts a failover test for the specified cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. diff --git a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt index e4c3b0ef6c..142cdfdd5e 100644 --- a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt +++ b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt @@ -12,10 +12,7 @@ atlas api clusters unpinFeatureCompatibilityVersion :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Unpins the current fixed Feature Compatibility Version (FCV). - -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. +Unpins the current fixed Feature Compatibility Version (FCV). This feature is not available for clusters on rapid release. diff --git a/docs/command/atlas-api-clusters-updateCluster.txt b/docs/command/atlas-api-clusters-updateCluster.txt index 880827fe4d..ebcb9722cb 100644 --- a/docs/command/atlas-api-clusters-updateCluster.txt +++ b/docs/command/atlas-api-clusters-updateCluster.txt @@ -12,10 +12,7 @@ atlas api clusters updateCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the details for one cluster in the specified project. - -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. +Updates the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can update clusters with asymmetrically-sized shards. To update a cluster's termination protection, the requesting Service Account or API Key must have the Project Owner role. For all other updates, the requesting Service Account or API Key must have the Project Cluster Manager role. You can't modify a paused cluster (paused : true). You must call this endpoint to set paused : false. After this endpoint responds with paused : false, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters. diff --git a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt index 310257d94f..d1dd9b5138 100644 --- a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt +++ b/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt @@ -12,10 +12,7 @@ atlas api clusters updateClusterAdvancedConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the advanced configuration details for one cluster in the specified project. - -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. +Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. diff --git a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt b/docs/command/atlas-api-clusters-upgradeSharedCluster.txt index 6fe8d74664..a9be193840 100644 --- a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt +++ b/docs/command/atlas-api-clusters-upgradeSharedCluster.txt @@ -12,10 +12,7 @@ atlas api clusters upgradeSharedCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. - -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. +Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. Each project supports up to 25 clusters. diff --git a/docs/command/atlas-api-clusters.txt b/docs/command/atlas-api-clusters.txt index ed4e705dfe..a28573c2a3 100644 --- a/docs/command/atlas-api-clusters.txt +++ b/docs/command/atlas-api-clusters.txt @@ -12,10 +12,7 @@ atlas api clusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes database deployments. - -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. +Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID. @@ -54,25 +51,25 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-clusters-autoScalingConfiguration` - `Public Preview: please provide feedback `_: Returns the internal configuration of AutoScaling for sharded clusters. -* :ref:`atlas-api-clusters-createCluster` - `Public Preview: please provide feedback `_: Creates one cluster in the specified project. -* :ref:`atlas-api-clusters-deleteCluster` - `Public Preview: please provide feedback `_: Removes one cluster from the specified project. -* :ref:`atlas-api-clusters-getCluster` - `Public Preview: please provide feedback `_: Returns the details for one cluster in the specified project. -* :ref:`atlas-api-clusters-getClusterAdvancedConfiguration` - `Public Preview: please provide feedback `_: Returns the advanced configuration details for one cluster in the specified project. -* :ref:`atlas-api-clusters-getClusterStatus` - `Public Preview: please provide feedback `_: Returns the status of all changes that you made to the specified cluster in the specified project. -* :ref:`atlas-api-clusters-getSampleDatasetLoadStatus` - `Public Preview: please provide feedback `_: Checks the progress of loading the sample dataset into one cluster. -* :ref:`atlas-api-clusters-grantMongoDbEmployeeAccess` - `Public Preview: please provide feedback `_: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. -* :ref:`atlas-api-clusters-listCloudProviderRegions` - `Public Preview: please provide feedback `_: Returns the list of regions available for the specified cloud provider at the specified tier. -* :ref:`atlas-api-clusters-listClusters` - `Public Preview: please provide feedback `_: Returns the details for all clusters in the specific project to which you have access. -* :ref:`atlas-api-clusters-listClustersForAllProjects` - `Public Preview: please provide feedback `_: Returns the details for all clusters in all projects to which you have access. -* :ref:`atlas-api-clusters-loadSampleDataset` - `Public Preview: please provide feedback `_: Requests loading the MongoDB sample dataset into the specified cluster. -* :ref:`atlas-api-clusters-pinFeatureCompatibilityVersion` - `Public Preview: please provide feedback `_: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. -* :ref:`atlas-api-clusters-revokeMongoDbEmployeeAccess` - `Public Preview: please provide feedback `_: Revokes a previously granted MongoDB employee cluster access. -* :ref:`atlas-api-clusters-testFailover` - `Public Preview: please provide feedback `_: Starts a failover test for the specified cluster in the specified project. -* :ref:`atlas-api-clusters-unpinFeatureCompatibilityVersion` - `Public Preview: please provide feedback `_: Unpins the current fixed Feature Compatibility Version (FCV). -* :ref:`atlas-api-clusters-updateCluster` - `Public Preview: please provide feedback `_: Updates the details for one cluster in the specified project. -* :ref:`atlas-api-clusters-updateClusterAdvancedConfiguration` - `Public Preview: please provide feedback `_: Updates the advanced configuration details for one cluster in the specified project. -* :ref:`atlas-api-clusters-upgradeSharedCluster` - `Public Preview: please provide feedback `_: Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. +* :ref:`atlas-api-clusters-autoScalingConfiguration` - Returns the internal configuration of AutoScaling for sharded clusters. +* :ref:`atlas-api-clusters-createCluster` - Creates one cluster in the specified project. +* :ref:`atlas-api-clusters-deleteCluster` - Removes one cluster from the specified project. +* :ref:`atlas-api-clusters-getCluster` - Returns the details for one cluster in the specified project. +* :ref:`atlas-api-clusters-getClusterAdvancedConfiguration` - Returns the advanced configuration details for one cluster in the specified project. +* :ref:`atlas-api-clusters-getClusterStatus` - Returns the status of all changes that you made to the specified cluster in the specified project. +* :ref:`atlas-api-clusters-getSampleDatasetLoadStatus` - Checks the progress of loading the sample dataset into one cluster. +* :ref:`atlas-api-clusters-grantMongoDbEmployeeAccess` - Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. +* :ref:`atlas-api-clusters-listCloudProviderRegions` - Returns the list of regions available for the specified cloud provider at the specified tier. +* :ref:`atlas-api-clusters-listClusters` - Returns the details for all clusters in the specific project to which you have access. +* :ref:`atlas-api-clusters-listClustersForAllProjects` - Returns the details for all clusters in all projects to which you have access. +* :ref:`atlas-api-clusters-loadSampleDataset` - Requests loading the MongoDB sample dataset into the specified cluster. +* :ref:`atlas-api-clusters-pinFeatureCompatibilityVersion` - Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. +* :ref:`atlas-api-clusters-revokeMongoDbEmployeeAccess` - Revokes a previously granted MongoDB employee cluster access. +* :ref:`atlas-api-clusters-testFailover` - Starts a failover test for the specified cluster in the specified project. +* :ref:`atlas-api-clusters-unpinFeatureCompatibilityVersion` - Unpins the current fixed Feature Compatibility Version (FCV). +* :ref:`atlas-api-clusters-updateCluster` - Updates the details for one cluster in the specified project. +* :ref:`atlas-api-clusters-updateClusterAdvancedConfiguration` - Updates the advanced configuration details for one cluster in the specified project. +* :ref:`atlas-api-clusters-upgradeSharedCluster` - Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt index ea3491f1cb..8cbf2640fe 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt @@ -12,10 +12,7 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceClusterMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. - -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. +Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. 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-getcollstatslatencynamespaceclustermeasurements. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt index 9cba091588..a0dc0a9bfa 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt @@ -12,10 +12,7 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceHostMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Get a list of the Coll Stats Latency process-level measurements for the given namespace. - -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. +Get a list of the Coll Stats Latency process-level measurements for the given namespace. 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-getcollstatslatencynamespacehostmeasurements. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt index f6fa24af73..6dbedce858 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt @@ -12,10 +12,7 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceMetrics :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. - -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. +Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. 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-getcollstatslatencynamespacemetrics. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt index 5ad7973c33..370be29a9a 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt @@ -12,10 +12,7 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. - -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. +Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. 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-getcollstatslatencynamespacesforcluster. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt index 834d236f10..25b0035da2 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt @@ -12,10 +12,7 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForHost :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. - -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. +Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. 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-getcollstatslatencynamespacesforhost. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt index 525b00442c..ff1df5759f 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt @@ -12,10 +12,7 @@ atlas api collectionLevelMetrics getPinnedNamespaces :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. - -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. +Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. 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-getpinnednamespaces. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt index b5f33bf709..89b6ffd5eb 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt @@ -12,10 +12,7 @@ atlas api collectionLevelMetrics pinNamespacesPatch :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. - -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. +Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. 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-pinnamespacespatch. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt index ae8e47f2bf..7f80c2ea3d 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt @@ -12,10 +12,7 @@ atlas api collectionLevelMetrics pinNamespacesPut :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. - -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. +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. diff --git a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt index 96fdaa2f94..5ed7b97b1e 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt @@ -12,10 +12,7 @@ atlas api collectionLevelMetrics unpinNamespaces :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. - -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. +Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. 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-unpinnamespaces. diff --git a/docs/command/atlas-api-collectionLevelMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics.txt index e69686c020..a5bd5c504a 100644 --- a/docs/command/atlas-api-collectionLevelMetrics.txt +++ b/docs/command/atlas-api-collectionLevelMetrics.txt @@ -12,10 +12,7 @@ atlas api collectionLevelMetrics :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, and edits pinned namespaces for the specified cluster or process. - -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. +Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level latency metric data. @@ -54,15 +51,15 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements` - `Public Preview: please provide feedback `_: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements` - `Public Preview: please provide feedback `_: Get a list of the Coll Stats Latency process-level measurements for the given namespace. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics` - `Public Preview: please provide feedback `_: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster` - `Public Preview: please provide feedback `_: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost` - `Public Preview: please provide feedback `_: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. -* :ref:`atlas-api-collectionLevelMetrics-getPinnedNamespaces` - `Public Preview: please provide feedback `_: Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. -* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPatch` - `Public Preview: please provide feedback `_: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. -* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPut` - `Public Preview: please provide feedback `_: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. -* :ref:`atlas-api-collectionLevelMetrics-unpinNamespaces` - `Public Preview: please provide feedback `_: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements` - Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements` - Get a list of the Coll Stats Latency process-level measurements for the given namespace. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics` - Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster` - Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost` - Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. +* :ref:`atlas-api-collectionLevelMetrics-getPinnedNamespaces` - Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. +* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPatch` - Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. +* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPut` - Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +* :ref:`atlas-api-collectionLevelMetrics-unpinNamespaces` - Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. .. toctree:: diff --git a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt index cddd1c8724..de7c9f352b 100644 --- a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt @@ -12,10 +12,7 @@ atlas api customDatabaseRoles createCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one custom role in the specified project. - -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. +Creates one custom role in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt index 0e61e06502..45ed27b0e7 100644 --- a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt @@ -12,10 +12,7 @@ atlas api customDatabaseRoles deleteCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one custom role from the specified project. - -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. +Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt index 6239d4dfe4..42f67c730f 100644 --- a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt @@ -12,10 +12,7 @@ atlas api customDatabaseRoles getCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one custom role for the specified project. - -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. +Returns one custom role for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt index eaf6020d91..15fa6ff7f1 100644 --- a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt +++ b/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt @@ -12,10 +12,7 @@ atlas api customDatabaseRoles listCustomDatabaseRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all custom roles for the specified project. - -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. +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. diff --git a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt index fc82f6c07b..aa06bb1269 100644 --- a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt @@ -12,10 +12,7 @@ atlas api customDatabaseRoles updateCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one custom role in the specified project. - -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. +Updates one custom role in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-customDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles.txt index 7c4bf67455..8dd6fc3d7a 100644 --- a/docs/command/atlas-api-customDatabaseRoles.txt +++ b/docs/command/atlas-api-customDatabaseRoles.txt @@ -12,10 +12,7 @@ atlas api customDatabaseRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes custom database user privilege roles. - -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. +Returns, adds, edits, and removes custom database user privilege roles. Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. You define custom roles at the project level, for all clusters in the project. This resource supports a subset of MongoDB privilege actions. You can create a subset of custom role actions. To create a wider list of custom role actions, use the MongoDB Cloud user interface. Custom roles must include actions that all project's clusters support, and that are compatible with each MongoDB version that your project's clusters use. For example, if your project has MongoDB 4.2 clusters, you can't create custom roles that use actions introduced in MongoDB 4.4. @@ -54,11 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-customDatabaseRoles-createCustomDatabaseRole` - `Public Preview: please provide feedback `_: Creates one custom role in the specified project. -* :ref:`atlas-api-customDatabaseRoles-deleteCustomDatabaseRole` - `Public Preview: please provide feedback `_: Removes one custom role from the specified project. -* :ref:`atlas-api-customDatabaseRoles-getCustomDatabaseRole` - `Public Preview: please provide feedback `_: Returns one custom role for the specified project. -* :ref:`atlas-api-customDatabaseRoles-listCustomDatabaseRoles` - `Public Preview: please provide feedback `_: Returns all custom roles for the specified project. -* :ref:`atlas-api-customDatabaseRoles-updateCustomDatabaseRole` - `Public Preview: please provide feedback `_: Updates one custom role in the specified project. +* :ref:`atlas-api-customDatabaseRoles-createCustomDatabaseRole` - Creates one custom role in the specified project. +* :ref:`atlas-api-customDatabaseRoles-deleteCustomDatabaseRole` - Removes one custom role from the specified project. +* :ref:`atlas-api-customDatabaseRoles-getCustomDatabaseRole` - Returns one custom role for the specified project. +* :ref:`atlas-api-customDatabaseRoles-listCustomDatabaseRoles` - Returns all custom roles for the specified project. +* :ref:`atlas-api-customDatabaseRoles-updateCustomDatabaseRole` - Updates one custom role in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt index 54510afedc..22b5df0d7e 100644 --- a/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt @@ -12,10 +12,7 @@ atlas api dataFederation createDataFederationPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. - -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. +Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. diff --git a/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt index 4759615bff..f52ab14589 100644 --- a/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt @@ -12,10 +12,7 @@ atlas api dataFederation createFederatedDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one federated database instance in the specified project. - -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. +Creates one federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. diff --git a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt b/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt index e90a642764..15482cb404 100644 --- a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt @@ -12,10 +12,7 @@ atlas api dataFederation createOneDataFederationQueryLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates or updates one query limit for one federated database instance. - -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. +Creates or updates one query limit for one federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt index 0bd95c9773..0526111869 100644 --- a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt @@ -12,10 +12,7 @@ atlas api dataFederation deleteDataFederationPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. - -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. +Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt index 493745465c..430a71cf6a 100644 --- a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt @@ -12,10 +12,7 @@ atlas api dataFederation deleteFederatedDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one federated database instance from the specified project. - -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. +Removes one federated database instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. diff --git a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt b/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt index f97cab75db..aeae55a265 100644 --- a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt @@ -12,10 +12,7 @@ atlas api dataFederation deleteOneDataFederationInstanceQueryLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes one query limit for one federated database instance. - -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. +Deletes one query limit for one federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt b/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt index d45c5490e8..e297865998 100644 --- a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt +++ b/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt @@ -12,10 +12,7 @@ atlas api dataFederation downloadFederatedDatabaseQueryLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Downloads the query logs for the specified federated database instance. - -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. +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". diff --git a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt index e6ab64cea4..392ac58858 100644 --- a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt @@ -12,10 +12,7 @@ atlas api dataFederation getDataFederationPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. - -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. +Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. diff --git a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt index e5d2b182a7..4c9a192848 100644 --- a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt @@ -12,10 +12,7 @@ atlas api dataFederation getFederatedDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the details of one federated database instance within the specified project. - -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. +Returns the details of one federated database instance within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. diff --git a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt b/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt index 4e4ec88db0..94ab053769 100644 --- a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt +++ b/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt @@ -12,10 +12,7 @@ atlas api dataFederation listDataFederationPrivateEndpoints :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. - -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. +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. diff --git a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt b/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt index 1afeeb6250..90c3088257 100644 --- a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt +++ b/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt @@ -12,10 +12,7 @@ atlas api dataFederation listFederatedDatabases :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the details of all federated database instances in the specified project. - -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. +Returns the details of all federated database instances in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or higher role. diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt index df56bb033d..b81a6a461f 100644 --- a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt @@ -12,10 +12,7 @@ atlas api dataFederation returnFederatedDatabaseQueryLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the details of one query limit for the specified federated database instance in the specified project. - -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. +Returns the details of one query limit for the specified federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt index ef07babdc1..8589a166a2 100644 --- a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt +++ b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt @@ -12,10 +12,7 @@ atlas api dataFederation returnFederatedDatabaseQueryLimits :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns query limits for a federated databases instance in the specified project. - -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. +Returns query limits for a federated databases instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt index e209bbcefd..6dcf586f6d 100644 --- a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt @@ -12,10 +12,7 @@ atlas api dataFederation updateFederatedDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the details of one federated database instance in the specified project. - -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. +Updates the details of one federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or higher role. diff --git a/docs/command/atlas-api-dataFederation.txt b/docs/command/atlas-api-dataFederation.txt index 4e39e60b74..ec96ccbd6a 100644 --- a/docs/command/atlas-api-dataFederation.txt +++ b/docs/command/atlas-api-dataFederation.txt @@ -12,10 +12,7 @@ atlas api dataFederation :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes Federated Database Instances. - -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. +Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs. @@ -54,20 +51,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-dataFederation-createDataFederationPrivateEndpoint` - `Public Preview: please provide feedback `_: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. -* :ref:`atlas-api-dataFederation-createFederatedDatabase` - `Public Preview: please provide feedback `_: Creates one federated database instance in the specified project. -* :ref:`atlas-api-dataFederation-createOneDataFederationQueryLimit` - `Public Preview: please provide feedback `_: Creates or updates one query limit for one federated database instance. -* :ref:`atlas-api-dataFederation-deleteDataFederationPrivateEndpoint` - `Public Preview: please provide feedback `_: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-deleteFederatedDatabase` - `Public Preview: please provide feedback `_: Removes one federated database instance from the specified project. -* :ref:`atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit` - `Public Preview: please provide feedback `_: Deletes one query limit for one federated database instance. -* :ref:`atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs` - `Public Preview: please provide feedback `_: Downloads the query logs for the specified federated database instance. -* :ref:`atlas-api-dataFederation-getDataFederationPrivateEndpoint` - `Public Preview: please provide feedback `_: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-getFederatedDatabase` - `Public Preview: please provide feedback `_: Returns the details of one federated database instance within the specified project. -* :ref:`atlas-api-dataFederation-listDataFederationPrivateEndpoints` - `Public Preview: please provide feedback `_: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-listFederatedDatabases` - `Public Preview: please provide feedback `_: Returns the details of all federated database instances in the specified project. -* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimit` - `Public Preview: please provide feedback `_: Returns the details of one query limit for the specified federated database instance in the specified project. -* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimits` - `Public Preview: please provide feedback `_: Returns query limits for a federated databases instance in the specified project. -* :ref:`atlas-api-dataFederation-updateFederatedDatabase` - `Public Preview: please provide feedback `_: Updates the details of one federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-createDataFederationPrivateEndpoint` - Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. +* :ref:`atlas-api-dataFederation-createFederatedDatabase` - Creates one federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-createOneDataFederationQueryLimit` - Creates or updates one query limit for one federated database instance. +* :ref:`atlas-api-dataFederation-deleteDataFederationPrivateEndpoint` - Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-deleteFederatedDatabase` - Removes one federated database instance from the specified project. +* :ref:`atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit` - Deletes one query limit for one federated database instance. +* :ref:`atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs` - Downloads the query logs for the specified federated database instance. +* :ref:`atlas-api-dataFederation-getDataFederationPrivateEndpoint` - Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-getFederatedDatabase` - Returns the details of one federated database instance within the specified project. +* :ref:`atlas-api-dataFederation-listDataFederationPrivateEndpoints` - Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-listFederatedDatabases` - Returns the details of all federated database instances in the specified project. +* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimit` - Returns the details of one query limit for the specified federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimits` - Returns query limits for a federated databases instance in the specified project. +* :ref:`atlas-api-dataFederation-updateFederatedDatabase` - Updates the details of one federated database instance in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt index c6a881abda..3c64148622 100644 --- a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt @@ -12,10 +12,7 @@ atlas api databaseUsers createDatabaseUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one database user in the specified project. - -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. +Creates one database user in the specified project. This MongoDB Cloud supports a maximum of 100 database users per project. If you require more than 100 database users on a project, contact Support. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt index a0dab0c03e..41ec0ced3e 100644 --- a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt @@ -12,10 +12,7 @@ atlas api databaseUsers deleteDatabaseUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one database user from the specified project. - -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. +Removes one database user from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt index f982191688..9db6782719 100644 --- a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt @@ -12,10 +12,7 @@ atlas api databaseUsers getDatabaseUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one database user that belong to the specified project. - -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. +Returns one database user that belong to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt index 6afcd62d89..f9f2460d0d 100644 --- a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt +++ b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt @@ -12,10 +12,7 @@ atlas api databaseUsers listDatabaseUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all database users that belong to the specified project. - -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. +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. diff --git a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt index e3605a7893..561d8020b4 100644 --- a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt @@ -12,10 +12,7 @@ atlas api databaseUsers updateDatabaseUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one database user that belongs to the specified project. - -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. +Updates one database user that belongs to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-databaseUsers.txt b/docs/command/atlas-api-databaseUsers.txt index a4b211cfb4..9c0ff4fef9 100644 --- a/docs/command/atlas-api-databaseUsers.txt +++ b/docs/command/atlas-api-databaseUsers.txt @@ -12,12 +12,7 @@ atlas api databaseUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes database users. - -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. - - +Returns, adds, edits, and removes database users. Options ------- @@ -54,11 +49,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-databaseUsers-createDatabaseUser` - `Public Preview: please provide feedback `_: Creates one database user in the specified project. -* :ref:`atlas-api-databaseUsers-deleteDatabaseUser` - `Public Preview: please provide feedback `_: Removes one database user from the specified project. -* :ref:`atlas-api-databaseUsers-getDatabaseUser` - `Public Preview: please provide feedback `_: Returns one database user that belong to the specified project. -* :ref:`atlas-api-databaseUsers-listDatabaseUsers` - `Public Preview: please provide feedback `_: Returns all database users that belong to the specified project. -* :ref:`atlas-api-databaseUsers-updateDatabaseUser` - `Public Preview: please provide feedback `_: Updates one database user that belongs to the specified project. +* :ref:`atlas-api-databaseUsers-createDatabaseUser` - Creates one database user in the specified project. +* :ref:`atlas-api-databaseUsers-deleteDatabaseUser` - Removes one database user from the specified project. +* :ref:`atlas-api-databaseUsers-getDatabaseUser` - Returns one database user that belong to the specified project. +* :ref:`atlas-api-databaseUsers-listDatabaseUsers` - Returns all database users that belong to the specified project. +* :ref:`atlas-api-databaseUsers-updateDatabaseUser` - Updates one database user that belongs to the specified project. .. toctree:: diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt index 50d7f5e979..c1e3d44d0c 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt @@ -12,10 +12,7 @@ atlas api encryptionAtRestUsingCustomerKeyManagement createEncryptionAtRestPriva :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates a private endpoint in the specified region for encryption at rest using customer key management. - -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. +Creates a private endpoint in the specified region for encryption at rest using customer key management. 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-createencryptionatrestprivateendpoint. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt index 27e582e378..27f9e47585 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt @@ -12,10 +12,7 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRest :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. - -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. +Returns the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting Service Account or API Key to have the Project Owner role. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt index a5ce596a19..2d75d01bd3 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt @@ -12,10 +12,7 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateE :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. - -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. +Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. 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-getencryptionatrestprivateendpoint. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt index cbb9fb3dcf..0a6b19820d 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt @@ -12,10 +12,7 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateE :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. - -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. +Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. 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-getencryptionatrestprivateendpointsforcloudprovider. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt index 0adc5345dd..872a73df8d 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt @@ -12,10 +12,7 @@ atlas api encryptionAtRestUsingCustomerKeyManagement requestEncryptionAtRestPriv :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. - -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. +Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. 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-requestencryptionatrestprivateendpointdeletion. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt index 7936d87b39..fe9378b280 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt @@ -12,10 +12,7 @@ atlas api encryptionAtRestUsingCustomerKeyManagement updateEncryptionAtRest :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. - -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. +Updates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting Service Account or API Key to have the Project Owner role. This feature isn't available for M0 free clusters, M2, M5, or serverless clusters. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt index 46dc2bea9f..389cb1e029 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt @@ -12,10 +12,7 @@ atlas api encryptionAtRestUsingCustomerKeyManagement :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns and edits the Encryption at Rest using Customer Key Management configuration. - -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. +Returns and edits the Encryption at Rest using Customer Key Management configuration. MongoDB Cloud encrypts all storage whether or not you use your own key management. @@ -54,12 +51,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint` - `Public Preview: please provide feedback `_: Creates a private endpoint in the specified region for encryption at rest using customer key management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest` - `Public Preview: please provide feedback `_: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint` - `Public Preview: please provide feedback `_: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider` - `Public Preview: please provide feedback `_: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion` - `Public Preview: please provide feedback `_: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest` - `Public Preview: please provide feedback `_: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint` - Creates a private endpoint in the specified region for encryption at rest using customer key management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest` - Returns the configuration for encryption at rest using the keys you manage through your cloud provider. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint` - Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider` - Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion` - Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest` - Updates the configuration for encryption at rest using the keys you manage through your cloud provider. .. toctree:: diff --git a/docs/command/atlas-api-events-getOrganizationEvent.txt b/docs/command/atlas-api-events-getOrganizationEvent.txt index 5aae2493b7..c7687f92b8 100644 --- a/docs/command/atlas-api-events-getOrganizationEvent.txt +++ b/docs/command/atlas-api-events-getOrganizationEvent.txt @@ -12,10 +12,7 @@ atlas api events getOrganizationEvent :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one event for the specified organization. - -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. +Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. Use the Return Events from One Organization endpoint to retrieve all events to which the authenticated user has access. diff --git a/docs/command/atlas-api-events-getProjectEvent.txt b/docs/command/atlas-api-events-getProjectEvent.txt index 6d3f469ae6..275067ef4e 100644 --- a/docs/command/atlas-api-events-getProjectEvent.txt +++ b/docs/command/atlas-api-events-getProjectEvent.txt @@ -12,10 +12,7 @@ atlas api events getProjectEvent :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one event for the specified project. - -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. +Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return Events from One Project endpoint to retrieve all events to which the authenticated user has access. diff --git a/docs/command/atlas-api-events-listEventTypes.txt b/docs/command/atlas-api-events-listEventTypes.txt index f1923a7960..04b6446579 100644 --- a/docs/command/atlas-api-events-listEventTypes.txt +++ b/docs/command/atlas-api-events-listEventTypes.txt @@ -12,10 +12,7 @@ atlas api events listEventTypes :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns a list of all event types, along with a description and additional metadata about each event. - -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. +Returns a list of all event types, along with a description and additional metadata about each event. 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-listeventtypes. diff --git a/docs/command/atlas-api-events-listOrganizationEvents.txt b/docs/command/atlas-api-events-listOrganizationEvents.txt index 41500d5a07..3fddb0278a 100644 --- a/docs/command/atlas-api-events-listOrganizationEvents.txt +++ b/docs/command/atlas-api-events-listOrganizationEvents.txt @@ -12,10 +12,7 @@ atlas api events listOrganizationEvents :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns events for the specified organization. - -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. +Returns events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-events-listProjectEvents.txt b/docs/command/atlas-api-events-listProjectEvents.txt index bb46fca30b..6ff969bede 100644 --- a/docs/command/atlas-api-events-listProjectEvents.txt +++ b/docs/command/atlas-api-events-listProjectEvents.txt @@ -12,10 +12,7 @@ atlas api events listProjectEvents :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns events for the specified project. - -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. +Returns events for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-events.txt b/docs/command/atlas-api-events.txt index b2a943d274..20dea625ea 100644 --- a/docs/command/atlas-api-events.txt +++ b/docs/command/atlas-api-events.txt @@ -12,10 +12,7 @@ atlas api events :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns events. - -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. +Returns events. This collection remains under revision and may change. @@ -54,11 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-events-getOrganizationEvent` - `Public Preview: please provide feedback `_: Returns one event for the specified organization. -* :ref:`atlas-api-events-getProjectEvent` - `Public Preview: please provide feedback `_: Returns one event for the specified project. -* :ref:`atlas-api-events-listEventTypes` - `Public Preview: please provide feedback `_: Returns a list of all event types, along with a description and additional metadata about each event. -* :ref:`atlas-api-events-listOrganizationEvents` - `Public Preview: please provide feedback `_: Returns events for the specified organization. -* :ref:`atlas-api-events-listProjectEvents` - `Public Preview: please provide feedback `_: Returns events for the specified project. +* :ref:`atlas-api-events-getOrganizationEvent` - Returns one event for the specified organization. +* :ref:`atlas-api-events-getProjectEvent` - Returns one event for the specified project. +* :ref:`atlas-api-events-listEventTypes` - Returns a list of all event types, along with a description and additional metadata about each event. +* :ref:`atlas-api-events-listOrganizationEvents` - Returns events for the specified organization. +* :ref:`atlas-api-events-listProjectEvents` - Returns events for the specified project. .. toctree:: diff --git a/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt index d9d3fedef7..22e8fa3813 100644 --- a/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt @@ -12,10 +12,7 @@ atlas api federatedAuthentication createIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one identity provider within the specified federation. - -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. +Creates one identity provider within the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt index 14a97847a5..736510bf86 100644 --- a/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt @@ -12,10 +12,7 @@ atlas api federatedAuthentication createRoleMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Adds one role mapping to the specified organization in the specified federation. - -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. +Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt b/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt index e6a3ceee82..79dda14637 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt @@ -12,10 +12,7 @@ atlas api federatedAuthentication deleteFederationApp :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes the federation settings instance and all associated data, including identity providers and domains. - -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. +Deletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the last remaining connected organization. Note: requests to this resource will fail if there is more than one connected organization in the federation. diff --git a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt index 672abe6d2f..a0a94f3672 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt @@ -12,10 +12,7 @@ atlas api federatedAuthentication deleteIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes one identity provider in the specified federation. - -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. +Deletes one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt index b310b65f50..e0e3781328 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt @@ -12,10 +12,7 @@ atlas api federatedAuthentication deleteRoleMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one role mapping in the specified organization from the specified federation. - -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. +Removes one role mapping in the specified organization from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt index 2aee3a4c3b..248bac6c2a 100644 --- a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt @@ -12,10 +12,7 @@ atlas api federatedAuthentication getConnectedOrgConfig :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the specified connected org config from the specified federation. - -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. +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. diff --git a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt index c052eef5d9..d0fcda9943 100644 --- a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt +++ b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt @@ -12,10 +12,7 @@ atlas api federatedAuthentication getFederationSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns information about the federation settings for the specified organization. - -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. +Returns information about the federation settings for the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt index bb6ae01a6c..729cb4da6d 100644 --- a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt @@ -12,10 +12,7 @@ atlas api federatedAuthentication getIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one identity provider in the specified federation by the identity provider's id. - -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. +Returns one identity provider in the specified federation by the identity provider's id. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt index 327dff2a99..4c9e36acec 100644 --- a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt +++ b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt @@ -12,10 +12,7 @@ atlas api federatedAuthentication getIdentityProviderMetadata :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the metadata of one identity provider in the specified federation. - -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. +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. diff --git a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt index 85736bc33f..a63f584d15 100644 --- a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt @@ -12,10 +12,7 @@ atlas api federatedAuthentication getRoleMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one role mapping from the specified organization in the specified federation. - -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. +Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt index 1d67d4e252..6b7124e0a8 100644 --- a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt +++ b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt @@ -12,10 +12,7 @@ atlas api federatedAuthentication listConnectedOrgConfigs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all connected org configs in the specified federation. - -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. +Returns all connected org configs in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected orgs. diff --git a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt index 345a92a0d7..93c8c423e3 100644 --- a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt +++ b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt @@ -12,10 +12,7 @@ atlas api federatedAuthentication listIdentityProviders :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all identity providers with the provided protocol and type in the specified federation. - -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. +Returns all identity providers with the provided protocol and type in the specified federation. If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt index 847183dc6a..e0b38af5a0 100644 --- a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt +++ b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt @@ -12,10 +12,7 @@ atlas api federatedAuthentication listRoleMappings :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all role mappings from the specified organization in the specified federation. - -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. +Returns all role mappings from the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt index 02e75700bb..bf55a85989 100644 --- a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt @@ -12,10 +12,7 @@ atlas api federatedAuthentication removeConnectedOrgConfig :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one connected organization configuration from the specified federation. - -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. +Removes one connected organization configuration from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation. diff --git a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt index 4c92f428a4..44d54e2001 100644 --- a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt @@ -12,10 +12,7 @@ atlas api federatedAuthentication revokeJwksFromIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Revokes the JWKS tokens from the requested OIDC identity provider. - -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. +Revokes the JWKS tokens from the requested OIDC identity provider. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt index 8c8bd42f72..8bd3f581bb 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt @@ -12,10 +12,7 @@ atlas api federatedAuthentication updateConnectedOrgConfig :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one connected organization configuration from the specified federation. - -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. +Updates one connected organization configuration from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt index 0c37d319be..89064ec6ec 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt @@ -12,10 +12,7 @@ atlas api federatedAuthentication updateIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one identity provider in the specified federation. - -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. +Updates one identity provider in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt index f6cbdf0492..7374c4b886 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt @@ -12,10 +12,7 @@ atlas api federatedAuthentication updateRoleMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one role mapping in the specified organization in the specified federation. - -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. +Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication.txt b/docs/command/atlas-api-federatedAuthentication.txt index 641db9b072..adb0fbbbec 100644 --- a/docs/command/atlas-api-federatedAuthentication.txt +++ b/docs/command/atlas-api-federatedAuthentication.txt @@ -12,12 +12,7 @@ atlas api federatedAuthentication :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. - -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. - - +Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. Options ------- @@ -54,24 +49,24 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-federatedAuthentication-createIdentityProvider` - `Public Preview: please provide feedback `_: Creates one identity provider within the specified federation. -* :ref:`atlas-api-federatedAuthentication-createRoleMapping` - `Public Preview: please provide feedback `_: Adds one role mapping to the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-deleteFederationApp` - `Public Preview: please provide feedback `_: Deletes the federation settings instance and all associated data, including identity providers and domains. -* :ref:`atlas-api-federatedAuthentication-deleteIdentityProvider` - `Public Preview: please provide feedback `_: Deletes one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-deleteRoleMapping` - `Public Preview: please provide feedback `_: Removes one role mapping in the specified organization from the specified federation. -* :ref:`atlas-api-federatedAuthentication-getConnectedOrgConfig` - `Public Preview: please provide feedback `_: Returns the specified connected org config from the specified federation. -* :ref:`atlas-api-federatedAuthentication-getFederationSettings` - `Public Preview: please provide feedback `_: Returns information about the federation settings for the specified organization. -* :ref:`atlas-api-federatedAuthentication-getIdentityProvider` - `Public Preview: please provide feedback `_: Returns one identity provider in the specified federation by the identity provider's id. -* :ref:`atlas-api-federatedAuthentication-getIdentityProviderMetadata` - `Public Preview: please provide feedback `_: Returns the metadata of one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-getRoleMapping` - `Public Preview: please provide feedback `_: Returns one role mapping from the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listConnectedOrgConfigs` - `Public Preview: please provide feedback `_: Returns all connected org configs in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listIdentityProviders` - `Public Preview: please provide feedback `_: Returns all identity providers with the provided protocol and type in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listRoleMappings` - `Public Preview: please provide feedback `_: Returns all role mappings from the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-removeConnectedOrgConfig` - `Public Preview: please provide feedback `_: Removes one connected organization configuration from the specified federation. -* :ref:`atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider` - `Public Preview: please provide feedback `_: Revokes the JWKS tokens from the requested OIDC identity provider. -* :ref:`atlas-api-federatedAuthentication-updateConnectedOrgConfig` - `Public Preview: please provide feedback `_: Updates one connected organization configuration from the specified federation. -* :ref:`atlas-api-federatedAuthentication-updateIdentityProvider` - `Public Preview: please provide feedback `_: Updates one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-updateRoleMapping` - `Public Preview: please provide feedback `_: Updates one role mapping in the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-createIdentityProvider` - Creates one identity provider within the specified federation. +* :ref:`atlas-api-federatedAuthentication-createRoleMapping` - Adds one role mapping to the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-deleteFederationApp` - Deletes the federation settings instance and all associated data, including identity providers and domains. +* :ref:`atlas-api-federatedAuthentication-deleteIdentityProvider` - Deletes one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-deleteRoleMapping` - Removes one role mapping in the specified organization from the specified federation. +* :ref:`atlas-api-federatedAuthentication-getConnectedOrgConfig` - Returns the specified connected org config from the specified federation. +* :ref:`atlas-api-federatedAuthentication-getFederationSettings` - Returns information about the federation settings for the specified organization. +* :ref:`atlas-api-federatedAuthentication-getIdentityProvider` - Returns one identity provider in the specified federation by the identity provider's id. +* :ref:`atlas-api-federatedAuthentication-getIdentityProviderMetadata` - Returns the metadata of one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-getRoleMapping` - Returns one role mapping from the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listConnectedOrgConfigs` - Returns all connected org configs in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listIdentityProviders` - Returns all identity providers with the provided protocol and type in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listRoleMappings` - Returns all role mappings from the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-removeConnectedOrgConfig` - Removes one connected organization configuration from the specified federation. +* :ref:`atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider` - Revokes the JWKS tokens from the requested OIDC identity provider. +* :ref:`atlas-api-federatedAuthentication-updateConnectedOrgConfig` - Updates one connected organization configuration from the specified federation. +* :ref:`atlas-api-federatedAuthentication-updateIdentityProvider` - Updates one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-updateRoleMapping` - Updates one role mapping in the specified organization in the specified federation. .. toctree:: diff --git a/docs/command/atlas-api-flexClusters-createFlexCluster.txt b/docs/command/atlas-api-flexClusters-createFlexCluster.txt index 6230433631..fc079bf9a4 100644 --- a/docs/command/atlas-api-flexClusters-createFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-createFlexCluster.txt @@ -12,10 +12,7 @@ atlas api flexClusters createFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one flex cluster in the specified project. - -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. +Creates one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt index bf8d6fedd4..4480658c5b 100644 --- a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt @@ -12,10 +12,7 @@ atlas api flexClusters deleteFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one flex cluster from the specified project. - -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. +Removes one flex cluster from the specified project. The flex cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-flexClusters-getFlexCluster.txt b/docs/command/atlas-api-flexClusters-getFlexCluster.txt index f0001be21e..63f4b86d65 100644 --- a/docs/command/atlas-api-flexClusters-getFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-getFlexCluster.txt @@ -12,10 +12,7 @@ atlas api flexClusters getFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details for one flex cluster in the specified project. - -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. +Returns details for one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-flexClusters-listFlexClusters.txt b/docs/command/atlas-api-flexClusters-listFlexClusters.txt index 4b96e02398..b0d82a9815 100644 --- a/docs/command/atlas-api-flexClusters-listFlexClusters.txt +++ b/docs/command/atlas-api-flexClusters-listFlexClusters.txt @@ -12,10 +12,7 @@ atlas api flexClusters listFlexClusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details for all flex clusters in the specified project. - -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. +Returns details for all flex clusters in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt index 0389fa29a3..f1b8d1f937 100644 --- a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt @@ -12,10 +12,7 @@ atlas api flexClusters updateFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one flex cluster in the specified project. - -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. +Updates one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt b/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt index fc0d58a06d..466f04382b 100644 --- a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt @@ -12,10 +12,7 @@ atlas api flexClusters upgradeFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. - -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. +Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. diff --git a/docs/command/atlas-api-flexClusters.txt b/docs/command/atlas-api-flexClusters.txt index 3df453a573..2ecadeb598 100644 --- a/docs/command/atlas-api-flexClusters.txt +++ b/docs/command/atlas-api-flexClusters.txt @@ -12,12 +12,7 @@ atlas api flexClusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes flex clusters. - -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. - - +Returns, adds, edits, and removes flex clusters. Options ------- @@ -54,12 +49,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexClusters-createFlexCluster` - `Public Preview: please provide feedback `_: Creates one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-deleteFlexCluster` - `Public Preview: please provide feedback `_: Removes one flex cluster from the specified project. -* :ref:`atlas-api-flexClusters-getFlexCluster` - `Public Preview: please provide feedback `_: Returns details for one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-listFlexClusters` - `Public Preview: please provide feedback `_: Returns details for all flex clusters in the specified project. -* :ref:`atlas-api-flexClusters-updateFlexCluster` - `Public Preview: please provide feedback `_: Updates one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-upgradeFlexCluster` - `Public Preview: please provide feedback `_: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. +* :ref:`atlas-api-flexClusters-createFlexCluster` - Creates one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-deleteFlexCluster` - Removes one flex cluster from the specified project. +* :ref:`atlas-api-flexClusters-getFlexCluster` - Returns details for one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-listFlexClusters` - Returns details for all flex clusters in the specified project. +* :ref:`atlas-api-flexClusters-updateFlexCluster` - Updates one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-upgradeFlexCluster` - Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt index 740f1ad825..ba022d3167 100644 --- a/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt +++ b/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt @@ -12,10 +12,7 @@ atlas api flexRestoreJobs createFlexBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Restores one snapshot of one flex cluster from the specified project. - -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. +Restores one snapshot of one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt index 6784778286..6ec3a2ced7 100644 --- a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt +++ b/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt @@ -12,10 +12,7 @@ atlas api flexRestoreJobs getFlexBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one restore job for one flex cluster from the specified project. - -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. +Returns one restore job for one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt index 7f9ef2bc42..0990c2b663 100644 --- a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt +++ b/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt @@ -12,10 +12,7 @@ atlas api flexRestoreJobs listFlexBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all restore jobs for one flex cluster from the specified project. - -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. +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. diff --git a/docs/command/atlas-api-flexRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs.txt index af1e93c687..6af27fc245 100644 --- a/docs/command/atlas-api-flexRestoreJobs.txt +++ b/docs/command/atlas-api-flexRestoreJobs.txt @@ -12,12 +12,7 @@ atlas api flexRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns and adds restore jobs for flex database deployments. - -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. - - +Returns and adds restore jobs for flex database deployments. Options ------- @@ -54,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexRestoreJobs-createFlexBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores one snapshot of one flex cluster from the specified project. -* :ref:`atlas-api-flexRestoreJobs-getFlexBackupRestoreJob` - `Public Preview: please provide feedback `_: Returns one restore job for one flex cluster from the specified project. -* :ref:`atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs` - `Public Preview: please provide feedback `_: Returns all restore jobs for one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-createFlexBackupRestoreJob` - Restores one snapshot of one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-getFlexBackupRestoreJob` - Returns one restore job for one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs` - Returns all restore jobs for one flex cluster from the specified project. .. toctree:: diff --git a/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt b/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt index 357e8c63e0..11641c1edd 100644 --- a/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt +++ b/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt @@ -12,10 +12,7 @@ atlas api flexSnapshots downloadFlexBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Requests one snapshot for the specified flex cluster. - -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. +Requests one snapshot for the specified flex cluster. This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt b/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt index a4db3d69b0..033e8bc219 100644 --- a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt +++ b/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt @@ -12,10 +12,7 @@ atlas api flexSnapshots getFlexBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one snapshot of one flex cluster from the specified project. - -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. +Returns one snapshot of one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt b/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt index e66a06c592..4e6b47fe25 100644 --- a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt +++ b/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt @@ -12,10 +12,7 @@ atlas api flexSnapshots listFlexBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all snapshots of one flex cluster from the specified project. - -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. +Returns all snapshots of one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-flexSnapshots.txt b/docs/command/atlas-api-flexSnapshots.txt index a284c15a44..7c6cf6a961 100644 --- a/docs/command/atlas-api-flexSnapshots.txt +++ b/docs/command/atlas-api-flexSnapshots.txt @@ -12,12 +12,7 @@ atlas api flexSnapshots :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns and requests to download flex database deployment snapshots. - -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. - - +Returns and requests to download flex database deployment snapshots. Options ------- @@ -54,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexSnapshots-downloadFlexBackup` - `Public Preview: please provide feedback `_: Requests one snapshot for the specified flex cluster. -* :ref:`atlas-api-flexSnapshots-getFlexBackup` - `Public Preview: please provide feedback `_: Returns one snapshot of one flex cluster from the specified project. -* :ref:`atlas-api-flexSnapshots-listFlexBackups` - `Public Preview: please provide feedback `_: Returns all snapshots of one flex cluster from the specified project. +* :ref:`atlas-api-flexSnapshots-downloadFlexBackup` - Requests one snapshot for the specified flex cluster. +* :ref:`atlas-api-flexSnapshots-getFlexBackup` - Returns one snapshot of one flex cluster from the specified project. +* :ref:`atlas-api-flexSnapshots-listFlexBackups` - Returns all snapshots of one flex cluster from the specified project. .. toctree:: diff --git a/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt b/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt index 678ce58271..3152f6af67 100644 --- a/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt +++ b/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt @@ -12,10 +12,7 @@ atlas api globalClusters createCustomZoneMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one custom zone mapping for the specified global cluster. - -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. +Creates one custom zone mapping for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt index 021d545786..f7d23b4988 100644 --- a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt @@ -12,10 +12,7 @@ atlas api globalClusters createManagedNamespace :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one managed namespace within the specified global cluster. - -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. +Creates one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt b/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt index 147ab2a78c..88735e5cef 100644 --- a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt +++ b/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt @@ -12,10 +12,7 @@ atlas api globalClusters deleteAllCustomZoneMappings :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes all custom zone mappings for the specified global cluster. - -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. +Removes all custom zone mappings for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt b/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt index ee636b332d..c317313771 100644 --- a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt @@ -12,10 +12,7 @@ atlas api globalClusters deleteManagedNamespace :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one managed namespace within the specified global cluster. - -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. +Removes one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt b/docs/command/atlas-api-globalClusters-getManagedNamespace.txt index d07ba6c19d..1c19076922 100644 --- a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-getManagedNamespace.txt @@ -12,10 +12,7 @@ atlas api globalClusters getManagedNamespace :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one managed namespace within the specified global cluster. - -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. +Returns one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-globalClusters.txt b/docs/command/atlas-api-globalClusters.txt index 1c7dc58029..8db86aa63c 100644 --- a/docs/command/atlas-api-globalClusters.txt +++ b/docs/command/atlas-api-globalClusters.txt @@ -12,10 +12,7 @@ atlas api globalClusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. - -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. +Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. Each collection in a Global Cluster is associated with a managed namespace. When you create a managed namespace for a Global Cluster, MongoDB Cloud creates an empty collection for that namespace. Creating a managed namespace doesn't populate a collection with data. Similarly, deleting a managed namespace doesn't delete the associated collection. MongoDB Cloud shards the empty collection using the required location field and a custom shard key. For example, if your custom shard key is city, the compound shard key is location, city. Each Global Cluster is also associated with one or more Global Writes Zones. When a user creates a Global Cluster, MongoDB Cloud automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. For example, a use case might require mapping a location code to a geographically distant zone. Administrators can manage custom zone mappings with the APIs below and the Global Cluster Configuration pane when you create or modify your Global Cluster. @@ -55,11 +52,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-globalClusters-createCustomZoneMapping` - `Public Preview: please provide feedback `_: Creates one custom zone mapping for the specified global cluster. -* :ref:`atlas-api-globalClusters-createManagedNamespace` - `Public Preview: please provide feedback `_: Creates one managed namespace within the specified global cluster. -* :ref:`atlas-api-globalClusters-deleteAllCustomZoneMappings` - `Public Preview: please provide feedback `_: Removes all custom zone mappings for the specified global cluster. -* :ref:`atlas-api-globalClusters-deleteManagedNamespace` - `Public Preview: please provide feedback `_: Removes one managed namespace within the specified global cluster. -* :ref:`atlas-api-globalClusters-getManagedNamespace` - `Public Preview: please provide feedback `_: Returns one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-createCustomZoneMapping` - Creates one custom zone mapping for the specified global cluster. +* :ref:`atlas-api-globalClusters-createManagedNamespace` - Creates one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-deleteAllCustomZoneMappings` - Removes all custom zone mappings for the specified global cluster. +* :ref:`atlas-api-globalClusters-deleteManagedNamespace` - Removes one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-getManagedNamespace` - Returns one managed namespace within the specified global cluster. .. toctree:: diff --git a/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt b/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt index 2a64115c66..f04623c086 100644 --- a/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt +++ b/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt @@ -12,10 +12,7 @@ atlas api invoices createCostExplorerQueryProcess :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates a query process within the Cost Explorer for the given parameters. - -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. +Creates a query process within the Cost Explorer for the given parameters. A token is returned that can be used to poll the status of the query and eventually retrieve the results. diff --git a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt b/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt index 91757d9e8d..ff57bcacd5 100644 --- a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt +++ b/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt @@ -12,10 +12,7 @@ atlas api invoices downloadInvoiceCsv :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one invoice that MongoDB issued to the specified organization in CSV format. - -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. +Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting Service Account or API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role. To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. diff --git a/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt b/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt index c2ec03fe4c..9ac686490c 100644 --- a/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt +++ b/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt @@ -12,10 +12,7 @@ atlas api invoices getCostExplorerQueryProcess :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. - -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. +Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data. diff --git a/docs/command/atlas-api-invoices-getInvoice.txt b/docs/command/atlas-api-invoices-getInvoice.txt index cceb2efcd7..de99de0b2a 100644 --- a/docs/command/atlas-api-invoices-getInvoice.txt +++ b/docs/command/atlas-api-invoices-getInvoice.txt @@ -12,10 +12,7 @@ atlas api invoices getInvoice :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one invoice that MongoDB issued to the specified organization. - -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. +Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner role. To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. diff --git a/docs/command/atlas-api-invoices-listInvoices.txt b/docs/command/atlas-api-invoices-listInvoices.txt index 375ace7246..56f500099e 100644 --- a/docs/command/atlas-api-invoices-listInvoices.txt +++ b/docs/command/atlas-api-invoices-listInvoices.txt @@ -12,10 +12,7 @@ atlas api invoices listInvoices :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all invoices that MongoDB issued to the specified organization. - -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. +Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner role. To compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. diff --git a/docs/command/atlas-api-invoices-listPendingInvoices.txt b/docs/command/atlas-api-invoices-listPendingInvoices.txt index f893f2b719..c6ced7a5e1 100644 --- a/docs/command/atlas-api-invoices-listPendingInvoices.txt +++ b/docs/command/atlas-api-invoices-listPendingInvoices.txt @@ -12,10 +12,7 @@ atlas api invoices listPendingInvoices :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all invoices accruing charges for the current billing cycle for the specified organization. - -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. +Returns all invoices accruing charges for the current billing cycle for the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. diff --git a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt b/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt index 68783354ff..c02a954553 100644 --- a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt +++ b/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt @@ -12,10 +12,7 @@ atlas api invoices queryLineItemsFromSingleInvoice :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Query the lineItems of the specified invoice and return the result JSON. - -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. +Query the lineItems of the specified invoice and return the result JSON. A unique 24-hexadecimal digit string identifies the invoice. diff --git a/docs/command/atlas-api-invoices.txt b/docs/command/atlas-api-invoices.txt index d94df194e7..85b96b9aa9 100644 --- a/docs/command/atlas-api-invoices.txt +++ b/docs/command/atlas-api-invoices.txt @@ -12,12 +12,7 @@ atlas api invoices :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns invoices. - -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. - - +Returns invoices. Options ------- @@ -54,13 +49,13 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-invoices-createCostExplorerQueryProcess` - `Public Preview: please provide feedback `_: Creates a query process within the Cost Explorer for the given parameters. -* :ref:`atlas-api-invoices-downloadInvoiceCsv` - `Public Preview: please provide feedback `_: Returns one invoice that MongoDB issued to the specified organization in CSV format. -* :ref:`atlas-api-invoices-getCostExplorerQueryProcess` - `Public Preview: please provide feedback `_: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. -* :ref:`atlas-api-invoices-getInvoice` - `Public Preview: please provide feedback `_: Returns one invoice that MongoDB issued to the specified organization. -* :ref:`atlas-api-invoices-listInvoices` - `Public Preview: please provide feedback `_: Returns all invoices that MongoDB issued to the specified organization. -* :ref:`atlas-api-invoices-listPendingInvoices` - `Public Preview: please provide feedback `_: Returns all invoices accruing charges for the current billing cycle for the specified organization. -* :ref:`atlas-api-invoices-queryLineItemsFromSingleInvoice` - `Public Preview: please provide feedback `_: Query the lineItems of the specified invoice and return the result JSON. +* :ref:`atlas-api-invoices-createCostExplorerQueryProcess` - Creates a query process within the Cost Explorer for the given parameters. +* :ref:`atlas-api-invoices-downloadInvoiceCsv` - Returns one invoice that MongoDB issued to the specified organization in CSV format. +* :ref:`atlas-api-invoices-getCostExplorerQueryProcess` - Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. +* :ref:`atlas-api-invoices-getInvoice` - Returns one invoice that MongoDB issued to the specified organization. +* :ref:`atlas-api-invoices-listInvoices` - Returns all invoices that MongoDB issued to the specified organization. +* :ref:`atlas-api-invoices-listPendingInvoices` - Returns all invoices accruing charges for the current billing cycle for the specified organization. +* :ref:`atlas-api-invoices-queryLineItemsFromSingleInvoice` - Query the lineItems of the specified invoice and return the result JSON. .. toctree:: diff --git a/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt index b029940d7f..d349c3bb3b 100644 --- a/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt @@ -12,10 +12,7 @@ atlas api ldapConfiguration deleteLdapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. - -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. +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. diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt index 102b5169c5..472da8c8ea 100644 --- a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt @@ -12,10 +12,7 @@ atlas api ldapConfiguration getLdapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the current LDAP configuration for the specified project. - -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. +Returns the current LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt index b24fd93e13..2f427141b2 100644 --- a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt +++ b/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt @@ -12,10 +12,7 @@ atlas api ldapConfiguration getLdapConfigurationStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the status of one request to verify one LDAP configuration for the specified project. - -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. +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. diff --git a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt index e11f80f92e..345be8a891 100644 --- a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt @@ -12,10 +12,7 @@ atlas api ldapConfiguration saveLdapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Edits the LDAP configuration for the specified project. - -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. +Edits the LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt index 711f109a4e..85ddd72b84 100644 --- a/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt @@ -12,10 +12,7 @@ atlas api ldapConfiguration verifyLdapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Verifies the LDAP configuration for the specified project. - -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. +Verifies the LDAP configuration for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-ldapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration.txt index 0bd261b391..dc6199e1bb 100644 --- a/docs/command/atlas-api-ldapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration.txt @@ -12,10 +12,7 @@ atlas api ldapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, edits, verifies, and removes LDAP configurations. - -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. +Returns, edits, verifies, and removes LDAP configurations. An LDAP configuration defines settings for MongoDB Cloud to connect to your LDAP server over TLS for user authentication and authorization. Your LDAP server must be visible to the internet or connected to your MongoDB Cloud cluster with VPC Peering. Also, your LDAP server must use TLS. You must have the MongoDB Cloud admin user privilege to use these endpoints. Also, to configure user authentication and authorization with LDAPS, your cluster must run MongoDB 3.6 or higher. Groups for which you have configured LDAPS can't create a cluster using a version of MongoDB 3.6 or lower. @@ -54,11 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-ldapConfiguration-deleteLdapConfiguration` - `Public Preview: please provide feedback `_: Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-getLdapConfiguration` - `Public Preview: please provide feedback `_: Returns the current LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-getLdapConfigurationStatus` - `Public Preview: please provide feedback `_: Returns the status of one request to verify one LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-saveLdapConfiguration` - `Public Preview: please provide feedback `_: Edits the LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-verifyLdapConfiguration` - `Public Preview: please provide feedback `_: Verifies the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-deleteLdapConfiguration` - Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-getLdapConfiguration` - Returns the current LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-getLdapConfigurationStatus` - Returns the status of one request to verify one LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-saveLdapConfiguration` - Edits the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-verifyLdapConfiguration` - Verifies the LDAP configuration for the specified project. .. toctree:: diff --git a/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt b/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt index 8908543bac..3dc8ca3f44 100644 --- a/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt +++ b/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt @@ -12,10 +12,7 @@ atlas api legacyBackup createLegacyBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Restores one legacy backup for one cluster in the specified project. - -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. +Restores one legacy backup for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying delivery.methodName of AUTOMATED_RESTORE in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. diff --git a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt index 8937f4e5b6..c54c4e6fbf 100644 --- a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt +++ b/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt @@ -12,10 +12,7 @@ atlas api legacyBackup deleteLegacySnapshot :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one legacy backup snapshot for one cluster in the specified project. - -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. +Removes one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt index a68d8d0240..b4c841ea66 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt @@ -12,10 +12,7 @@ atlas api legacyBackup getLegacyBackupCheckpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one legacy backup checkpoint for one cluster in the specified project. - -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. +Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt index d66027d40d..786f2621e3 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt @@ -12,10 +12,7 @@ atlas api legacyBackup getLegacyBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one legacy backup restore job for one cluster in the specified project. - -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. +Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt index 108f4bf66d..7eaccd41c5 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt @@ -12,10 +12,7 @@ atlas api legacyBackup getLegacySnapshot :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one legacy backup snapshot for one cluster in the specified project. - -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. +Returns one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt index f02333810a..f4931d344d 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt @@ -12,10 +12,7 @@ atlas api legacyBackup getLegacySnapshotSchedule :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the snapshot schedule for one cluster in the specified project. - -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. +Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt index 02d692d370..1c6094ee00 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt @@ -12,10 +12,7 @@ atlas api legacyBackup listLegacyBackupCheckpoints :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all legacy backup checkpoints for one cluster in the specified project. - -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. +Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt index c86e97d0d0..cfa9b38345 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt @@ -12,10 +12,7 @@ atlas api legacyBackup listLegacyBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all legacy backup restore jobs for one cluster in the specified project. - -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. +Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt b/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt index 87e2e03f93..4aec03c82f 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt @@ -12,10 +12,7 @@ atlas api legacyBackup listLegacySnapshots :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all legacy backup snapshots for one cluster in the specified project. - -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. +Returns all legacy backup snapshots for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt index 11945268fd..f7fd998ec1 100644 --- a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt +++ b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt @@ -12,10 +12,7 @@ atlas api legacyBackup updateLegacySnapshotRetention :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. - -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. +Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt index a994a3b1b3..9d8d6a175f 100644 --- a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt +++ b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt @@ -12,10 +12,7 @@ atlas api legacyBackup updateLegacySnapshotSchedule :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the snapshot schedule for one cluster in the specified project. - -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. +Updates the snapshot schedule for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-legacyBackup.txt b/docs/command/atlas-api-legacyBackup.txt index 440d2bd94f..36acd1d547 100644 --- a/docs/command/atlas-api-legacyBackup.txt +++ b/docs/command/atlas-api-legacyBackup.txt @@ -12,12 +12,7 @@ atlas api legacyBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. - -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. - - +Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. Options ------- @@ -54,17 +49,17 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-legacyBackup-createLegacyBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores one legacy backup for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-deleteLegacySnapshot` - `Public Preview: please provide feedback `_: Removes one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacyBackupCheckpoint` - `Public Preview: please provide feedback `_: Returns one legacy backup checkpoint for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacyBackupRestoreJob` - `Public Preview: please provide feedback `_: Returns one legacy backup restore job for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacySnapshot` - `Public Preview: please provide feedback `_: Returns one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacySnapshotSchedule` - `Public Preview: please provide feedback `_: Returns the snapshot schedule for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacyBackupCheckpoints` - `Public Preview: please provide feedback `_: Returns all legacy backup checkpoints for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacyBackupRestoreJobs` - `Public Preview: please provide feedback `_: Returns all legacy backup restore jobs for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacySnapshots` - `Public Preview: please provide feedback `_: Returns all legacy backup snapshots for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-updateLegacySnapshotRetention` - `Public Preview: please provide feedback `_: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-updateLegacySnapshotSchedule` - `Public Preview: please provide feedback `_: Updates the snapshot schedule for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-createLegacyBackupRestoreJob` - Restores one legacy backup for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-deleteLegacySnapshot` - Removes one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacyBackupCheckpoint` - Returns one legacy backup checkpoint for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacyBackupRestoreJob` - Returns one legacy backup restore job for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacySnapshot` - Returns one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacySnapshotSchedule` - Returns the snapshot schedule for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacyBackupCheckpoints` - Returns all legacy backup checkpoints for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacyBackupRestoreJobs` - Returns all legacy backup restore jobs for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacySnapshots` - Returns all legacy backup snapshots for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-updateLegacySnapshotRetention` - Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-updateLegacySnapshotSchedule` - Updates the snapshot schedule for one cluster in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt index f76a6509a7..f511bf8153 100644 --- a/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt @@ -12,10 +12,7 @@ atlas api maintenanceWindows deferMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Defers the maintenance window for the specified project. - -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. +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. diff --git a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt index a4c4b730be..c33c9ecedf 100644 --- a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt @@ -12,10 +12,7 @@ atlas api maintenanceWindows getMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the maintenance window for the specified project. - -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. +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. diff --git a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt index d23fe8eb34..19f29e95cd 100644 --- a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt @@ -12,10 +12,7 @@ atlas api maintenanceWindows resetMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Resets the maintenance window for the specified project. - -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. +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. diff --git a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt index 0ea96dd8a3..e255bddebb 100644 --- a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt +++ b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt @@ -12,10 +12,7 @@ atlas api maintenanceWindows toggleMaintenanceAutoDefer :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Toggles automatic deferral of the maintenance window for the specified project. - -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. +Toggles automatic deferral of the maintenance window for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt index f12b9c7621..8595304029 100644 --- a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt @@ -12,10 +12,7 @@ atlas api maintenanceWindows updateMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the maintenance window for the specified project. - -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. +Updates the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. Updating the maintenance window will reset any maintenance deferrals for this project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-maintenanceWindows.txt b/docs/command/atlas-api-maintenanceWindows.txt index 2ff75c5f27..e8b8e09988 100644 --- a/docs/command/atlas-api-maintenanceWindows.txt +++ b/docs/command/atlas-api-maintenanceWindows.txt @@ -12,10 +12,7 @@ atlas api maintenanceWindows :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, edits, and removes maintenance windows. - -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. +Returns, edits, and removes maintenance windows. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. You can defer a scheduled maintenance event for a project up to two times. Deferred maintenance events occur during your preferred maintenance window exactly one week after the previously scheduled date and time. @@ -54,11 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-maintenanceWindows-deferMaintenanceWindow` - `Public Preview: please provide feedback `_: Defers the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-getMaintenanceWindow` - `Public Preview: please provide feedback `_: Returns the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-resetMaintenanceWindow` - `Public Preview: please provide feedback `_: Resets the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer` - `Public Preview: please provide feedback `_: Toggles automatic deferral of the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-updateMaintenanceWindow` - `Public Preview: please provide feedback `_: Updates the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-deferMaintenanceWindow` - Defers the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-getMaintenanceWindow` - Returns the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-resetMaintenanceWindow` - Resets the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer` - Toggles automatic deferral of the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-updateMaintenanceWindow` - Updates the maintenance window for the specified project. .. toctree:: diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt index ec643c1edc..9f9cfedef3 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers addOrganizationRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Adds one organization-level role to the MongoDB Cloud user. - -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. +Adds one organization-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt index 936a809163..038cc61741 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers addProjectRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Adds one project-level role to the MongoDB Cloud user. - -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. +Adds one project-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has been invited to join the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt index 0246d7ca47..8f1db24979 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers addProjectUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to one project. - -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. +Adds one MongoDB Cloud user to one project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt b/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt index 81db1cd717..fff8a31ab6 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers addUserToTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to one team. - -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. +Adds one MongoDB Cloud user to one team. You can add an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt index 64b29f3b14..629e3709ea 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers createOrganizationUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Invites one new or existing MongoDB Cloud user to join the organization. - -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. +Invites one new or existing MongoDB Cloud user to join the organization. The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt index 2d78ee2575..ba298d852f 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers createUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one MongoDB Cloud user account. - -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. +Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt index d8032adc76..5280087404 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers getOrganizationUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns information about the specified MongoDB Cloud user within the context of the specified organization. - -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. +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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt index 422cc877d9..11983f6356 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers getProjectUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns information about the specified MongoDB Cloud user within the context of the specified project. - -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. +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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt index 360415f74c..1684fbf469 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers getUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. - -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. +Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. You can't use this endpoint to return information on an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. You can always retrieve your own user account. If you are the owner of a MongoDB Cloud organization or project, you can also retrieve the user profile for any user with membership in that organization or project. To use this resource, the requesting Service Account or API Key can have any role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt index 716a5e25f5..4469969009 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers getUserByUsername :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the details for one MongoDB Cloud user account with the specified username. - -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. +Returns the details for one MongoDB Cloud user account with the specified username. You can't use this endpoint to return information about an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. To use this resource, the requesting Service Account or API Key can have any role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt index 5cace75d1f..4361eea7a7 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers listOrganizationUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified organization. - -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. +Returns details about the pending and active MongoDB Cloud users associated with the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt index 034220e5ad..664669e28f 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers listProjectUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified project. - -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. +Returns details about the pending and active MongoDB Cloud users associated with the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt index 8c47c0f3d4..3859ae4d17 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers listTeamUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. - -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. +Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt index 34fd05e1e6..9cf2d8e96d 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers removeOrganizationRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one organization-level role from the MongoDB Cloud user. - -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. +Removes one organization-level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt index 5f80d485e3..aa5e205d06 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers removeOrganizationUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user in the specified organization. - -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. +Removes one MongoDB Cloud user in the specified organization. You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt index d07a313196..3161651545 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers removeProjectRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one project-level role from the MongoDB Cloud user. - -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. +Removes one project-level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has been invited to join the project. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt index 3a88b2d9af..f80e896ed2 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers removeProjectUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from the specified project. - -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. +Removes one MongoDB Cloud user from the specified project. You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt index 4547a9a4f6..dd580f0c91 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers removeUserFromTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from one team. - -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. +Removes one MongoDB Cloud user from one team. You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt index c564b8a697..cf94e5ae7e 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt @@ -12,10 +12,7 @@ atlas api mongoDbCloudUsers updateOrganizationUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one MongoDB Cloud user in the specified organization. - -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. +Updates one MongoDB Cloud user in the specified organization. You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers.txt index 3f5e8e90dd..33a954365f 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers.txt @@ -12,12 +12,7 @@ atlas api mongoDbCloudUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, and edits MongoDB Cloud users. - -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. - - +Returns, adds, and edits MongoDB Cloud users. Options ------- @@ -54,25 +49,25 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-mongoDbCloudUsers-addOrganizationRole` - `Public Preview: please provide feedback `_: Adds one organization-level role to the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-addProjectRole` - `Public Preview: please provide feedback `_: Adds one project-level role to the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-addProjectUser` - `Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to one project. -* :ref:`atlas-api-mongoDbCloudUsers-addUserToTeam` - `Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to one team. -* :ref:`atlas-api-mongoDbCloudUsers-createOrganizationUser` - `Public Preview: please provide feedback `_: Invites one new or existing MongoDB Cloud user to join the organization. -* :ref:`atlas-api-mongoDbCloudUsers-createUser` - `Public Preview: please provide feedback `_: Creates one MongoDB Cloud user account. -* :ref:`atlas-api-mongoDbCloudUsers-getOrganizationUser` - `Public Preview: please provide feedback `_: Returns information about the specified MongoDB Cloud user within the context of the specified organization. -* :ref:`atlas-api-mongoDbCloudUsers-getProjectUser` - `Public Preview: please provide feedback `_: Returns information about the specified MongoDB Cloud user within the context of the specified project. -* :ref:`atlas-api-mongoDbCloudUsers-getUser` - `Public Preview: please provide feedback `_: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. -* :ref:`atlas-api-mongoDbCloudUsers-getUserByUsername` - `Public Preview: please provide feedback `_: Returns the details for one MongoDB Cloud user account with the specified username. -* :ref:`atlas-api-mongoDbCloudUsers-listOrganizationUsers` - `Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified organization. -* :ref:`atlas-api-mongoDbCloudUsers-listProjectUsers` - `Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified project. -* :ref:`atlas-api-mongoDbCloudUsers-listTeamUsers` - `Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. -* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationRole` - `Public Preview: please provide feedback `_: Removes one organization-level role from the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationUser` - `Public Preview: please provide feedback `_: Removes one MongoDB Cloud user in the specified organization. -* :ref:`atlas-api-mongoDbCloudUsers-removeProjectRole` - `Public Preview: please provide feedback `_: Removes one project-level role from the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-removeProjectUser` - `Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from the specified project. -* :ref:`atlas-api-mongoDbCloudUsers-removeUserFromTeam` - `Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from one team. -* :ref:`atlas-api-mongoDbCloudUsers-updateOrganizationUser` - `Public Preview: please provide feedback `_: Updates one MongoDB Cloud user in the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-addOrganizationRole` - Adds one organization-level role to the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-addProjectRole` - Adds one project-level role to the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-addProjectUser` - Adds one MongoDB Cloud user to one project. +* :ref:`atlas-api-mongoDbCloudUsers-addUserToTeam` - Adds one MongoDB Cloud user to one team. +* :ref:`atlas-api-mongoDbCloudUsers-createOrganizationUser` - Invites one new or existing MongoDB Cloud user to join the organization. +* :ref:`atlas-api-mongoDbCloudUsers-createUser` - Creates one MongoDB Cloud user account. +* :ref:`atlas-api-mongoDbCloudUsers-getOrganizationUser` - Returns information about the specified MongoDB Cloud user within the context of the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-getProjectUser` - Returns information about the specified MongoDB Cloud user within the context of the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-getUser` - Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. +* :ref:`atlas-api-mongoDbCloudUsers-getUserByUsername` - Returns the details for one MongoDB Cloud user account with the specified username. +* :ref:`atlas-api-mongoDbCloudUsers-listOrganizationUsers` - Returns details about the pending and active MongoDB Cloud users associated with the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-listProjectUsers` - Returns details about the pending and active MongoDB Cloud users associated with the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-listTeamUsers` - Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. +* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationRole` - Removes one organization-level role from the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationUser` - Removes one MongoDB Cloud user in the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-removeProjectRole` - Removes one project-level role from the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-removeProjectUser` - Removes one MongoDB Cloud user from the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-removeUserFromTeam` - Removes one MongoDB Cloud user from one team. +* :ref:`atlas-api-mongoDbCloudUsers-updateOrganizationUser` - Updates one MongoDB Cloud user in the specified organization. .. toctree:: diff --git a/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt b/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt index 21bdc6900c..044f893a5c 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt @@ -12,10 +12,7 @@ atlas api monitoringAndLogs getAtlasProcess :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the processes for the specified host for the specified project. - -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. +Returns the processes for the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt index 8ca4e1a2ee..63dff12d7b 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt @@ -12,10 +12,7 @@ atlas api monitoringAndLogs getDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one database running on the specified host for the specified project. - -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. +Returns one database running on the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt index 6cd09a57e7..23a443aa29 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt @@ -12,10 +12,7 @@ atlas api monitoringAndLogs getDatabaseMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the measurements of one database for the specified host for the specified project. - -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. +Returns the measurements of one database for the specified host for the specified project. Returns the database's on-disk storage space based on the MongoDB dbStats command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt index bc0028b8de..a1b90cacd6 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt @@ -12,10 +12,7 @@ atlas api monitoringAndLogs getDiskMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the measurements of one disk or partition for the specified host for the specified project. - -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. +Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following: diff --git a/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt b/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt index ab35961c9b..2b5a18f9db 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt @@ -12,10 +12,7 @@ atlas api monitoringAndLogs getHostLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. - -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. +Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes. Logs are stored in chunks approximately five minutes in length, but this duration may vary. If you poll the API for log files, we recommend polling every five minutes even though consecutive polls could contain some overlapping logs. This feature isn't available for M0 free clusters, M2, M5, flex, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". diff --git a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt index 530bb45903..6f07417951 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt @@ -12,10 +12,7 @@ atlas api monitoringAndLogs getHostMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns disk, partition, or host measurements per process for the specified host for the specified project. - -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. +Returns disk, partition, or host measurements per process for the specified host for the specified project. Returned value can be one of the following: diff --git a/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt b/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt index c5027a5e18..8c6f1aef7e 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt @@ -12,10 +12,7 @@ atlas api monitoringAndLogs getIndexMetrics :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. - -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. +Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. You must have the Project Read Only or higher role to view the Atlas Search metric types. diff --git a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt index b2dff7d212..caf2c36bfb 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt @@ -12,10 +12,7 @@ atlas api monitoringAndLogs getMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. - -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. +Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. diff --git a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt b/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt index d3c8604664..717c511208 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt @@ -12,10 +12,7 @@ atlas api monitoringAndLogs listAtlasProcesses :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details of all processes for the specified project. - -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. +Returns details of all processes for the specified project. A MongoDB process can be either a mongod or mongos. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt index c89638552e..394d3817e2 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt @@ -12,10 +12,7 @@ atlas api monitoringAndLogs listDatabases :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the list of databases running on the specified host for the specified project. - -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. +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. diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt index 69cba675be..6f17bfd587 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt @@ -12,10 +12,7 @@ atlas api monitoringAndLogs listDiskMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns measurement details for one disk or partition for the specified host for the specified project. - -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. +Returns measurement details for one disk or partition for the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt index 28a3e16b58..05447b9b9c 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt @@ -12,10 +12,7 @@ atlas api monitoringAndLogs listDiskPartitions :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the list of disks or partitions for the specified host for the specified project. - -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. +Returns the list of disks or partitions for the specified host for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt b/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt index 9801b4893b..953676b5fe 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt @@ -12,10 +12,7 @@ atlas api monitoringAndLogs listIndexMetrics :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. - -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. +Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. 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-listindexmetrics. diff --git a/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt b/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt index 1695da8cca..f1ac8c3c7d 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt @@ -12,10 +12,7 @@ atlas api monitoringAndLogs listMetricTypes :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all Atlas Search metric types available for one process in the specified project. - -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. +Returns all Atlas Search metric types available for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. diff --git a/docs/command/atlas-api-monitoringAndLogs.txt b/docs/command/atlas-api-monitoringAndLogs.txt index 7a4ed28df9..28b7245c4c 100644 --- a/docs/command/atlas-api-monitoringAndLogs.txt +++ b/docs/command/atlas-api-monitoringAndLogs.txt @@ -12,12 +12,7 @@ atlas api monitoringAndLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns database deployment monitoring and logging data. - -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. - - +Returns database deployment monitoring and logging data. Options ------- @@ -54,20 +49,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-monitoringAndLogs-getAtlasProcess` - `Public Preview: please provide feedback `_: Returns the processes for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDatabase` - `Public Preview: please provide feedback `_: Returns one database running on the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDatabaseMeasurements` - `Public Preview: please provide feedback `_: Returns the measurements of one database for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDiskMeasurements` - `Public Preview: please provide feedback `_: Returns the measurements of one disk or partition for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getHostLogs` - `Public Preview: please provide feedback `_: Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getHostMeasurements` - `Public Preview: please provide feedback `_: Returns disk, partition, or host measurements per process for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getIndexMetrics` - `Public Preview: please provide feedback `_: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. -* :ref:`atlas-api-monitoringAndLogs-getMeasurements` - `Public Preview: please provide feedback `_: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. -* :ref:`atlas-api-monitoringAndLogs-listAtlasProcesses` - `Public Preview: please provide feedback `_: Returns details of all processes for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDatabases` - `Public Preview: please provide feedback `_: Returns the list of databases running on the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDiskMeasurements` - `Public Preview: please provide feedback `_: Returns measurement details for one disk or partition for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDiskPartitions` - `Public Preview: please provide feedback `_: Returns the list of disks or partitions for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listIndexMetrics` - `Public Preview: please provide feedback `_: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. -* :ref:`atlas-api-monitoringAndLogs-listMetricTypes` - `Public Preview: please provide feedback `_: Returns all Atlas Search metric types available for one process in the specified project. +* :ref:`atlas-api-monitoringAndLogs-getAtlasProcess` - Returns the processes for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDatabase` - Returns one database running on the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDatabaseMeasurements` - Returns the measurements of one database for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDiskMeasurements` - Returns the measurements of one disk or partition for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getHostLogs` - Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getHostMeasurements` - Returns disk, partition, or host measurements per process for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getIndexMetrics` - Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. +* :ref:`atlas-api-monitoringAndLogs-getMeasurements` - Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. +* :ref:`atlas-api-monitoringAndLogs-listAtlasProcesses` - Returns details of all processes for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDatabases` - Returns the list of databases running on the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDiskMeasurements` - Returns measurement details for one disk or partition for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDiskPartitions` - Returns the list of disks or partitions for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listIndexMetrics` - Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. +* :ref:`atlas-api-monitoringAndLogs-listMetricTypes` - Returns all Atlas Search metric types available for one process in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-networkPeering-createPeeringConnection.txt b/docs/command/atlas-api-networkPeering-createPeeringConnection.txt index 75e4adaa33..847a914c95 100644 --- a/docs/command/atlas-api-networkPeering-createPeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-createPeeringConnection.txt @@ -12,10 +12,7 @@ atlas api networkPeering createPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one new network peering connection in the specified project. - -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. +Creates one new network peering connection in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. diff --git a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt b/docs/command/atlas-api-networkPeering-createPeeringContainer.txt index 1afd125531..084b532e72 100644 --- a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-createPeeringContainer.txt @@ -12,10 +12,7 @@ atlas api networkPeering createPeeringContainer :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one new network peering container in the specified project. - -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. +Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt b/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt index 01122141b3..29b4bb97e1 100644 --- a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt @@ -12,10 +12,7 @@ atlas api networkPeering deletePeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one network peering connection in the specified project. - -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. +Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt b/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt index a4cadcf699..33cdb1149e 100644 --- a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt @@ -12,10 +12,7 @@ atlas api networkPeering deletePeeringContainer :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one network peering container in the specified project. - -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. +Removes one network peering container in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-networkPeering-disablePeering.txt b/docs/command/atlas-api-networkPeering-disablePeering.txt index 9807f5cd4c..144cf463ef 100644 --- a/docs/command/atlas-api-networkPeering-disablePeering.txt +++ b/docs/command/atlas-api-networkPeering-disablePeering.txt @@ -12,10 +12,7 @@ atlas api networkPeering disablePeering :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Disables Connect via Peering Only mode for the specified project. - -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. +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. diff --git a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt b/docs/command/atlas-api-networkPeering-getPeeringConnection.txt index 3b4b7d1f7e..a00680c44d 100644 --- a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-getPeeringConnection.txt @@ -12,10 +12,7 @@ atlas api networkPeering getPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details about one specified network peering connection in the specified project. - -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. +Returns details about one specified network peering connection in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt b/docs/command/atlas-api-networkPeering-getPeeringContainer.txt index 8c993bda16..3ed109d020 100644 --- a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-getPeeringContainer.txt @@ -12,10 +12,7 @@ atlas api networkPeering getPeeringContainer :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details about one network peering container in one specified project. - -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. +Returns details about one network peering container in one specified project. Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt b/docs/command/atlas-api-networkPeering-listPeeringConnections.txt index 6ad10aad1c..fd4327a001 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringConnections.txt @@ -12,10 +12,7 @@ atlas api networkPeering listPeeringConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details about all network peering connections in the specified project. - -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. +Returns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt b/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt index 0e31b61106..3e95ffc7a0 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt @@ -12,10 +12,7 @@ atlas api networkPeering listPeeringContainerByCloudProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details about all network peering containers in the specified project for the specified cloud provider. - -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. +Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt b/docs/command/atlas-api-networkPeering-listPeeringContainers.txt index 8271d86a6d..179cabb33e 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringContainers.txt @@ -12,10 +12,7 @@ atlas api networkPeering listPeeringContainers :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details about all network peering containers in the specified project. - -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. +Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt b/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt index 57359ff737..80ea39302c 100644 --- a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt @@ -12,10 +12,7 @@ atlas api networkPeering updatePeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one specified network peering connection in the specified project. - -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. +Updates one specified network peering connection in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt b/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt index 9bc0eea78e..8dd2751d16 100644 --- a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt @@ -12,10 +12,7 @@ atlas api networkPeering updatePeeringContainer :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the network details and labels of one specified network peering container in the specified project. - -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. +Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt b/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt index 909cc084a0..70da472ff1 100644 --- a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt +++ b/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt @@ -12,10 +12,7 @@ atlas api networkPeering verifyConnectViaPeeringOnlyModeForOneProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Verifies if someone set the specified project to Connect via Peering Only mode. - -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. +Verifies if someone set the specified project to Connect via Peering Only mode. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-networkPeering.txt b/docs/command/atlas-api-networkPeering.txt index c18ba278bc..491982631f 100644 --- a/docs/command/atlas-api-networkPeering.txt +++ b/docs/command/atlas-api-networkPeering.txt @@ -12,10 +12,7 @@ atlas api networkPeering :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes network peering containers and peering connections. - -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. +Returns, adds, edits, and removes network peering containers and peering connections. When you deploy an M10+ dedicated cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block. @@ -54,19 +51,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-networkPeering-createPeeringConnection` - `Public Preview: please provide feedback `_: Creates one new network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-createPeeringContainer` - `Public Preview: please provide feedback `_: Creates one new network peering container in the specified project. -* :ref:`atlas-api-networkPeering-deletePeeringConnection` - `Public Preview: please provide feedback `_: Removes one network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-deletePeeringContainer` - `Public Preview: please provide feedback `_: Removes one network peering container in the specified project. -* :ref:`atlas-api-networkPeering-disablePeering` - `Public Preview: please provide feedback `_: Disables Connect via Peering Only mode for the specified project. -* :ref:`atlas-api-networkPeering-getPeeringConnection` - `Public Preview: please provide feedback `_: Returns details about one specified network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-getPeeringContainer` - `Public Preview: please provide feedback `_: Returns details about one network peering container in one specified project. -* :ref:`atlas-api-networkPeering-listPeeringConnections` - `Public Preview: please provide feedback `_: Returns details about all network peering connections in the specified project. -* :ref:`atlas-api-networkPeering-listPeeringContainerByCloudProvider` - `Public Preview: please provide feedback `_: Returns details about all network peering containers in the specified project for the specified cloud provider. -* :ref:`atlas-api-networkPeering-listPeeringContainers` - `Public Preview: please provide feedback `_: Returns details about all network peering containers in the specified project. -* :ref:`atlas-api-networkPeering-updatePeeringConnection` - `Public Preview: please provide feedback `_: Updates one specified network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-updatePeeringContainer` - `Public Preview: please provide feedback `_: Updates the network details and labels of one specified network peering container in the specified project. -* :ref:`atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject` - `Public Preview: please provide feedback `_: Verifies if someone set the specified project to Connect via Peering Only mode. +* :ref:`atlas-api-networkPeering-createPeeringConnection` - Creates one new network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-createPeeringContainer` - Creates one new network peering container in the specified project. +* :ref:`atlas-api-networkPeering-deletePeeringConnection` - Removes one network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-deletePeeringContainer` - Removes one network peering container in the specified project. +* :ref:`atlas-api-networkPeering-disablePeering` - Disables Connect via Peering Only mode for the specified project. +* :ref:`atlas-api-networkPeering-getPeeringConnection` - Returns details about one specified network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-getPeeringContainer` - Returns details about one network peering container in one specified project. +* :ref:`atlas-api-networkPeering-listPeeringConnections` - Returns details about all network peering connections in the specified project. +* :ref:`atlas-api-networkPeering-listPeeringContainerByCloudProvider` - Returns details about all network peering containers in the specified project for the specified cloud provider. +* :ref:`atlas-api-networkPeering-listPeeringContainers` - Returns details about all network peering containers in the specified project. +* :ref:`atlas-api-networkPeering-updatePeeringConnection` - Updates one specified network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-updatePeeringContainer` - Updates the network details and labels of one specified network peering container in the specified project. +* :ref:`atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject` - Verifies if someone set the specified project to Connect via Peering Only mode. .. toctree:: diff --git a/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt index 4617498e57..2f2afecb6b 100644 --- a/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt @@ -12,10 +12,7 @@ atlas api onlineArchive createOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one online archive. - -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. +Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt index 7d07246800..d474636ae0 100644 --- a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt @@ -12,10 +12,7 @@ atlas api onlineArchive deleteOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one online archive. - -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. +Removes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt b/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt index c06c643bac..1d4da952e6 100644 --- a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt +++ b/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt @@ -12,10 +12,7 @@ atlas api onlineArchive downloadOnlineArchiveQueryLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Downloads query logs for the specified online archive. - -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. +Downloads query logs for the specified online archive. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". diff --git a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt index 4913c5c8be..6dda49e2c0 100644 --- a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt @@ -12,10 +12,7 @@ atlas api onlineArchive getOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one online archive for one cluster. - -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. +Returns one online archive for one cluster. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt index 94025ee0f9..d5ff03b093 100644 --- a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt +++ b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt @@ -12,10 +12,7 @@ atlas api onlineArchive listOnlineArchives :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details of all online archives. - -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. +Returns details of all online archives. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt index 6a387ba44a..ce09e2d608 100644 --- a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt @@ -12,10 +12,7 @@ atlas api onlineArchive updateOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates, pauses, or resumes one online archive. - -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. +Updates, pauses, or resumes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-onlineArchive.txt b/docs/command/atlas-api-onlineArchive.txt index 0e7fbd36ce..d76e4693ab 100644 --- a/docs/command/atlas-api-onlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive.txt @@ -12,12 +12,7 @@ atlas api onlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, or removes an online archive. - -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. - - +Returns, adds, edits, or removes an online archive. Options ------- @@ -54,12 +49,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-onlineArchive-createOnlineArchive` - `Public Preview: please provide feedback `_: Creates one online archive. -* :ref:`atlas-api-onlineArchive-deleteOnlineArchive` - `Public Preview: please provide feedback `_: Removes one online archive. -* :ref:`atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs` - `Public Preview: please provide feedback `_: Downloads query logs for the specified online archive. -* :ref:`atlas-api-onlineArchive-getOnlineArchive` - `Public Preview: please provide feedback `_: Returns one online archive for one cluster. -* :ref:`atlas-api-onlineArchive-listOnlineArchives` - `Public Preview: please provide feedback `_: Returns details of all online archives. -* :ref:`atlas-api-onlineArchive-updateOnlineArchive` - `Public Preview: please provide feedback `_: Updates, pauses, or resumes one online archive. +* :ref:`atlas-api-onlineArchive-createOnlineArchive` - Creates one online archive. +* :ref:`atlas-api-onlineArchive-deleteOnlineArchive` - Removes one online archive. +* :ref:`atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs` - Downloads query logs for the specified online archive. +* :ref:`atlas-api-onlineArchive-getOnlineArchive` - Returns one online archive for one cluster. +* :ref:`atlas-api-onlineArchive-listOnlineArchives` - Returns details of all online archives. +* :ref:`atlas-api-onlineArchive-updateOnlineArchive` - Updates, pauses, or resumes one online archive. .. toctree:: diff --git a/docs/command/atlas-api-organizations-createOrganization.txt b/docs/command/atlas-api-organizations-createOrganization.txt index 360108b6bc..f844c91a3c 100644 --- a/docs/command/atlas-api-organizations-createOrganization.txt +++ b/docs/command/atlas-api-organizations-createOrganization.txt @@ -12,10 +12,7 @@ atlas api organizations createOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. - -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. +Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. The requesting Service Account's or API Key's organization must be a paying organization. To learn more, see Configure a Paying Organization in the MongoDB Atlas documentation. diff --git a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt b/docs/command/atlas-api-organizations-createOrganizationInvitation.txt index 9e1b2feafe..03122028bb 100644 --- a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-createOrganizationInvitation.txt @@ -12,10 +12,7 @@ atlas api organizations createOrganizationInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Invites one MongoDB Cloud user to join the specified organization. - -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. +Invites one MongoDB Cloud user to join the specified organization. The user must accept the invitation to access information within the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-deleteOrganization.txt b/docs/command/atlas-api-organizations-deleteOrganization.txt index fb91eb69ff..460df10deb 100644 --- a/docs/command/atlas-api-organizations-deleteOrganization.txt +++ b/docs/command/atlas-api-organizations-deleteOrganization.txt @@ -12,10 +12,7 @@ atlas api organizations deleteOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one specified organization. - -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. +Removes one specified organization. MongoDB Cloud imposes the following limits on this resource: diff --git a/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt b/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt index b48e734d08..7a2e73888e 100644 --- a/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt @@ -12,10 +12,7 @@ atlas api organizations deleteOrganizationInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. - -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. +Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. You can't cancel an invitation that the user accepted. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-getOrganization.txt b/docs/command/atlas-api-organizations-getOrganization.txt index 5a7b2287d1..973eee168a 100644 --- a/docs/command/atlas-api-organizations-getOrganization.txt +++ b/docs/command/atlas-api-organizations-getOrganization.txt @@ -12,10 +12,7 @@ atlas api organizations getOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one organization to which the requesting Service Account or API Key has access. - -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. +Returns one organization to which the requesting Service Account or API Key has access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt b/docs/command/atlas-api-organizations-getOrganizationInvitation.txt index dad1c7fab1..255ed46a17 100644 --- a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-getOrganizationInvitation.txt @@ -12,10 +12,7 @@ atlas api organizations getOrganizationInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the details of one pending invitation to the specified organization. - -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. +Returns the details of one pending invitation to the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-getOrganizationSettings.txt b/docs/command/atlas-api-organizations-getOrganizationSettings.txt index 6323add4b5..041caf9a1e 100644 --- a/docs/command/atlas-api-organizations-getOrganizationSettings.txt +++ b/docs/command/atlas-api-organizations-getOrganizationSettings.txt @@ -12,10 +12,7 @@ atlas api organizations getOrganizationSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details about the specified organization's settings. - -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. +Returns details about the specified organization's settings. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt index 67c1414fc5..b2f3be5c4c 100644 --- a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt +++ b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt @@ -12,10 +12,7 @@ atlas api organizations listOrganizationInvitations :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all pending invitations to the specified organization. - -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. +Returns all pending invitations to the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-listOrganizationProjects.txt b/docs/command/atlas-api-organizations-listOrganizationProjects.txt index d7743085a7..da12efea46 100644 --- a/docs/command/atlas-api-organizations-listOrganizationProjects.txt +++ b/docs/command/atlas-api-organizations-listOrganizationProjects.txt @@ -12,10 +12,7 @@ atlas api organizations listOrganizationProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns multiple projects in the specified organization. - -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. +Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to: diff --git a/docs/command/atlas-api-organizations-listOrganizations.txt b/docs/command/atlas-api-organizations-listOrganizations.txt index 44d3b692fa..769843f5a2 100644 --- a/docs/command/atlas-api-organizations-listOrganizations.txt +++ b/docs/command/atlas-api-organizations-listOrganizations.txt @@ -12,10 +12,7 @@ atlas api organizations listOrganizations :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all organizations to which the requesting Service Account or API Key has access. - -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. +Returns all organizations to which the requesting Service Account or API Key has access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-organizations-updateOrganization.txt b/docs/command/atlas-api-organizations-updateOrganization.txt index cc7ef4f679..263aaa4854 100644 --- a/docs/command/atlas-api-organizations-updateOrganization.txt +++ b/docs/command/atlas-api-organizations-updateOrganization.txt @@ -12,10 +12,7 @@ atlas api organizations updateOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one organization. - -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. +Updates one organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt index fdeed3d05a..8f7fb444a1 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt @@ -12,10 +12,7 @@ atlas api organizations updateOrganizationInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. - -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. +Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt index 97b96ce5d5..175ba7187c 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt @@ -12,10 +12,7 @@ atlas api organizations updateOrganizationInvitationById :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by its unique ID, to the specified organization. - -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. +Updates the details of one pending invitation, identified by its unique ID, to the specified organization. Use the Return All Organization Invitations endpoint to retrieve IDs for all pending organization invitations. To use this resource, the requesting API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt b/docs/command/atlas-api-organizations-updateOrganizationRoles.txt index b7df785369..69c128f9b9 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationRoles.txt @@ -12,10 +12,7 @@ atlas api organizations updateOrganizationRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the roles of the specified user in the specified organization. - -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. +Updates the roles of the specified user in the specified organization. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization User Admin role. diff --git a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt b/docs/command/atlas-api-organizations-updateOrganizationSettings.txt index 938c3e176a..5b31dd9a0f 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationSettings.txt @@ -12,10 +12,7 @@ atlas api organizations updateOrganizationSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the organization's settings. - -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. +Updates the organization's settings. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations.txt b/docs/command/atlas-api-organizations.txt index 8466aa5ef6..c354e29e8b 100644 --- a/docs/command/atlas-api-organizations.txt +++ b/docs/command/atlas-api-organizations.txt @@ -12,12 +12,7 @@ atlas api organizations :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, and edits organizational units in MongoDB Cloud. - -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. - - +Returns, adds, and edits organizational units in MongoDB Cloud. Options ------- @@ -54,21 +49,21 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-organizations-createOrganization` - `Public Preview: please provide feedback `_: Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. -* :ref:`atlas-api-organizations-createOrganizationInvitation` - `Public Preview: please provide feedback `_: Invites one MongoDB Cloud user to join the specified organization. -* :ref:`atlas-api-organizations-deleteOrganization` - `Public Preview: please provide feedback `_: Removes one specified organization. -* :ref:`atlas-api-organizations-deleteOrganizationInvitation` - `Public Preview: please provide feedback `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. -* :ref:`atlas-api-organizations-getOrganization` - `Public Preview: please provide feedback `_: Returns one organization to which the requesting Service Account or API Key has access. -* :ref:`atlas-api-organizations-getOrganizationInvitation` - `Public Preview: please provide feedback `_: Returns the details of one pending invitation to the specified organization. -* :ref:`atlas-api-organizations-getOrganizationSettings` - `Public Preview: please provide feedback `_: Returns details about the specified organization's settings. -* :ref:`atlas-api-organizations-listOrganizationInvitations` - `Public Preview: please provide feedback `_: Returns all pending invitations to the specified organization. -* :ref:`atlas-api-organizations-listOrganizationProjects` - `Public Preview: please provide feedback `_: Returns multiple projects in the specified organization. -* :ref:`atlas-api-organizations-listOrganizations` - `Public Preview: please provide feedback `_: Returns all organizations to which the requesting Service Account or API Key has access. -* :ref:`atlas-api-organizations-updateOrganization` - `Public Preview: please provide feedback `_: Updates one organization. -* :ref:`atlas-api-organizations-updateOrganizationInvitation` - `Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationInvitationById` - `Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by its unique ID, to the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationRoles` - `Public Preview: please provide feedback `_: Updates the roles of the specified user in the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationSettings` - `Public Preview: please provide feedback `_: Updates the organization's settings. +* :ref:`atlas-api-organizations-createOrganization` - Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. +* :ref:`atlas-api-organizations-createOrganizationInvitation` - Invites one MongoDB Cloud user to join the specified organization. +* :ref:`atlas-api-organizations-deleteOrganization` - Removes one specified organization. +* :ref:`atlas-api-organizations-deleteOrganizationInvitation` - Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. +* :ref:`atlas-api-organizations-getOrganization` - Returns one organization to which the requesting Service Account or API Key has access. +* :ref:`atlas-api-organizations-getOrganizationInvitation` - Returns the details of one pending invitation to the specified organization. +* :ref:`atlas-api-organizations-getOrganizationSettings` - Returns details about the specified organization's settings. +* :ref:`atlas-api-organizations-listOrganizationInvitations` - Returns all pending invitations to the specified organization. +* :ref:`atlas-api-organizations-listOrganizationProjects` - Returns multiple projects in the specified organization. +* :ref:`atlas-api-organizations-listOrganizations` - Returns all organizations to which the requesting Service Account or API Key has access. +* :ref:`atlas-api-organizations-updateOrganization` - Updates one organization. +* :ref:`atlas-api-organizations-updateOrganizationInvitation` - Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. +* :ref:`atlas-api-organizations-updateOrganizationInvitationById` - Updates the details of one pending invitation, identified by its unique ID, to the specified organization. +* :ref:`atlas-api-organizations-updateOrganizationRoles` - Updates the roles of the specified user in the specified organization. +* :ref:`atlas-api-organizations-updateOrganizationSettings` - Updates the organization's settings. .. toctree:: diff --git a/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt b/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt index bfacd308af..dd97b4e0da 100644 --- a/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt +++ b/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt @@ -12,10 +12,7 @@ atlas api performanceAdvisor disableSlowOperationThresholding :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. - -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. +Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt b/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt index aa6b6525be..5480d42f83 100644 --- a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt +++ b/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt @@ -12,10 +12,7 @@ atlas api performanceAdvisor enableSlowOperationThresholding :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Enables MongoDB Cloud to use its slow operation threshold for the specified project. - -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. +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. diff --git a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt index 714eea5f31..4c6dbfb2ba 100644 --- a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt +++ b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt @@ -12,10 +12,7 @@ atlas api performanceAdvisor getManagedSlowMs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Get whether the Managed Slow MS feature is enabled. - -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. +Get whether the Managed Slow MS feature is enabled. 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-getmanagedslowms. diff --git a/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt index 923b3da69c..07ffffe593 100644 --- a/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt +++ b/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt @@ -12,10 +12,7 @@ atlas api performanceAdvisor getServerlessAutoIndexing :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Get whether the Serverless Auto Indexing feature is enabled. - -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. +Get whether the Serverless Auto Indexing feature is enabled. This endpoint returns 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. diff --git a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt index 98aff293b5..d2e3c1d4cf 100644 --- a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt @@ -12,10 +12,7 @@ atlas api performanceAdvisor listClusterSuggestedIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests. - -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. +Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt index a4a8cc4d81..dae35b215f 100644 --- a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt @@ -12,10 +12,7 @@ atlas api performanceAdvisor listDropIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests to drop. - -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. +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. diff --git a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt index ba37e40c89..be048584e4 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt @@ -12,10 +12,7 @@ atlas api performanceAdvisor listSchemaAdvice :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the schema suggestions that the Performance Advisor detects. - -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. +Returns the schema suggestions that the Performance Advisor detects. The Performance Advisor provides holistic schema recommendations for your cluster by sampling documents in your most active collections and collections with slow-running queries. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt index 2f9e4201c3..4d3a1efaa0 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt @@ -12,10 +12,7 @@ atlas api performanceAdvisor listSlowQueries :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. - -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. +Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting Service Account or API Key must have any Project Data Access role or the Project Observability Viewer role. diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt index 011610c5cf..f947c644f8 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt @@ -12,10 +12,7 @@ atlas api performanceAdvisor listSlowQueryNamespaces :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. - -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. +Returns up to 20 namespaces for collections experiencing slow queries on the specified host. If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt index 4801247f36..ff5615b53f 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt @@ -12,10 +12,7 @@ atlas api performanceAdvisor listSuggestedIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests. - -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. +Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt index 2d56acc5ca..eb59172368 100644 --- a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt +++ b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt @@ -12,10 +12,7 @@ atlas api performanceAdvisor setServerlessAutoIndexing :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Set whether the Serverless Auto Indexing feature is enabled. - -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. +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. diff --git a/docs/command/atlas-api-performanceAdvisor.txt b/docs/command/atlas-api-performanceAdvisor.txt index c1187dfdf8..315c90abbd 100644 --- a/docs/command/atlas-api-performanceAdvisor.txt +++ b/docs/command/atlas-api-performanceAdvisor.txt @@ -12,10 +12,7 @@ atlas api performanceAdvisor :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns suggested indexes and slow query data for a database deployment. - -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. +Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a sample query, you must have the Project Data Access Read Only role or higher. Otherwise, MongoDB Cloud returns redacted data rather than the field values. @@ -54,17 +51,17 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-performanceAdvisor-disableSlowOperationThresholding` - `Public Preview: please provide feedback `_: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. -* :ref:`atlas-api-performanceAdvisor-enableSlowOperationThresholding` - `Public Preview: please provide feedback `_: Enables MongoDB Cloud to use its slow operation threshold for the specified project. -* :ref:`atlas-api-performanceAdvisor-getManagedSlowMs` - `Public Preview: please provide feedback `_: Get whether the Managed Slow MS feature is enabled. -* :ref:`atlas-api-performanceAdvisor-getServerlessAutoIndexing` - `Public Preview: please provide feedback `_: Get whether the Serverless Auto Indexing feature is enabled. -* :ref:`atlas-api-performanceAdvisor-listClusterSuggestedIndexes` - `Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests. -* :ref:`atlas-api-performanceAdvisor-listDropIndexes` - `Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests to drop. -* :ref:`atlas-api-performanceAdvisor-listSchemaAdvice` - `Public Preview: please provide feedback `_: Returns the schema suggestions that the Performance Advisor detects. -* :ref:`atlas-api-performanceAdvisor-listSlowQueries` - `Public Preview: please provide feedback `_: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. -* :ref:`atlas-api-performanceAdvisor-listSlowQueryNamespaces` - `Public Preview: please provide feedback `_: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. -* :ref:`atlas-api-performanceAdvisor-listSuggestedIndexes` - `Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests. -* :ref:`atlas-api-performanceAdvisor-setServerlessAutoIndexing` - `Public Preview: please provide feedback `_: Set whether the Serverless Auto Indexing feature is enabled. +* :ref:`atlas-api-performanceAdvisor-disableSlowOperationThresholding` - Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. +* :ref:`atlas-api-performanceAdvisor-enableSlowOperationThresholding` - Enables MongoDB Cloud to use its slow operation threshold for the specified project. +* :ref:`atlas-api-performanceAdvisor-getManagedSlowMs` - Get whether the Managed Slow MS feature is enabled. +* :ref:`atlas-api-performanceAdvisor-getServerlessAutoIndexing` - Get whether the Serverless Auto Indexing feature is enabled. +* :ref:`atlas-api-performanceAdvisor-listClusterSuggestedIndexes` - Returns the indexes that the Performance Advisor suggests. +* :ref:`atlas-api-performanceAdvisor-listDropIndexes` - Returns the indexes that the Performance Advisor suggests to drop. +* :ref:`atlas-api-performanceAdvisor-listSchemaAdvice` - Returns the schema suggestions that the Performance Advisor detects. +* :ref:`atlas-api-performanceAdvisor-listSlowQueries` - Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. +* :ref:`atlas-api-performanceAdvisor-listSlowQueryNamespaces` - Returns up to 20 namespaces for collections experiencing slow queries on the specified host. +* :ref:`atlas-api-performanceAdvisor-listSuggestedIndexes` - Returns the indexes that the Performance Advisor suggests. +* :ref:`atlas-api-performanceAdvisor-setServerlessAutoIndexing` - Set whether the Serverless Auto Indexing feature is enabled. .. toctree:: diff --git a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt index a1a2b5a8fb..3585ccd10e 100644 --- a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt @@ -12,10 +12,7 @@ atlas api privateEndpointServices createPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one private endpoint for the specified cloud service provider. - -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. +Creates one private endpoint for the specified cloud service provider. This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. diff --git a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt index 083b4ef385..5311163626 100644 --- a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt @@ -12,10 +12,7 @@ atlas api privateEndpointServices createPrivateEndpointService :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one private endpoint service for the specified cloud service provider. - -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. +Creates one private endpoint service for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt index 57635b889c..ba253449d7 100644 --- a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt @@ -12,10 +12,7 @@ atlas api privateEndpointServices deletePrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. - -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. +Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt index 7208a88a90..9bc5be6f42 100644 --- a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt @@ -12,10 +12,7 @@ atlas api privateEndpointServices deletePrivateEndpointService :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one private endpoint service from the specified project. - -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. +Removes one private endpoint service from the specified project. This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt index 1cbaa0057e..400fd0bf33 100644 --- a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt @@ -12,10 +12,7 @@ atlas api privateEndpointServices getPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the connection state of the specified private endpoint. - -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. +Returns the connection state of the specified private endpoint. The private endpoint service manages this private endpoint which belongs to one project hosted from one cloud service provider. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt index 01ad4be3fd..2ec0ad94ed 100644 --- a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt @@ -12,10 +12,7 @@ atlas api privateEndpointServices getPrivateEndpointService :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the name, interfaces, and state of the specified private endpoint service from one project. - -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. +Returns the name, interfaces, and state of the specified private endpoint service from one project. The cloud service provider hosted this private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt index df378d1f1c..6ea39540bd 100644 --- a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt +++ b/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt @@ -12,10 +12,7 @@ atlas api privateEndpointServices getRegionalizedPrivateEndpointSetting :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. - -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. +Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. The cloud service provider manages the private endpoint for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt index e526d9318e..e9c5c22fdd 100644 --- a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt +++ b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt @@ -12,10 +12,7 @@ atlas api privateEndpointServices listPrivateEndpointServices :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. - -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. +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. diff --git a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt index 99f1f75538..d353db631e 100644 --- a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt +++ b/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt @@ -12,10 +12,7 @@ atlas api privateEndpointServices toggleRegionalizedPrivateEndpointSetting :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. - -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. +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. diff --git a/docs/command/atlas-api-privateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices.txt index 0037af955e..c294bc065c 100644 --- a/docs/command/atlas-api-privateEndpointServices.txt +++ b/docs/command/atlas-api-privateEndpointServices.txt @@ -12,12 +12,7 @@ atlas api privateEndpointServices :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes private endpoint services. - -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. - - +Returns, adds, edits, and removes private endpoint services. Options ------- @@ -54,15 +49,15 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-privateEndpointServices-createPrivateEndpoint` - `Public Preview: please provide feedback `_: Creates one private endpoint for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-createPrivateEndpointService` - `Public Preview: please provide feedback `_: Creates one private endpoint service for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpoint` - `Public Preview: please provide feedback `_: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpointService` - `Public Preview: please provide feedback `_: Removes one private endpoint service from the specified project. -* :ref:`atlas-api-privateEndpointServices-getPrivateEndpoint` - `Public Preview: please provide feedback `_: Returns the connection state of the specified private endpoint. -* :ref:`atlas-api-privateEndpointServices-getPrivateEndpointService` - `Public Preview: please provide feedback `_: Returns the name, interfaces, and state of the specified private endpoint service from one project. -* :ref:`atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting` - `Public Preview: please provide feedback `_: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. -* :ref:`atlas-api-privateEndpointServices-listPrivateEndpointServices` - `Public Preview: please provide feedback `_: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting` - `Public Preview: please provide feedback `_: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. +* :ref:`atlas-api-privateEndpointServices-createPrivateEndpoint` - Creates one private endpoint for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-createPrivateEndpointService` - Creates one private endpoint service for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpoint` - Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpointService` - Removes one private endpoint service from the specified project. +* :ref:`atlas-api-privateEndpointServices-getPrivateEndpoint` - Returns the connection state of the specified private endpoint. +* :ref:`atlas-api-privateEndpointServices-getPrivateEndpointService` - Returns the name, interfaces, and state of the specified private endpoint service from one project. +* :ref:`atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting` - Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. +* :ref:`atlas-api-privateEndpointServices-listPrivateEndpointServices` - Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting` - Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. .. toctree:: diff --git a/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt index d5793d1532..11b5f83b58 100644 --- a/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt @@ -12,10 +12,7 @@ atlas api programmaticApiKeys addProjectApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Assigns the specified organization API key to the specified project. - -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. +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. diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt index acab8b8b97..300998b420 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt @@ -12,10 +12,7 @@ atlas api programmaticApiKeys createApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one API key for the specified organization. - -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. +Creates one API key for the specified organization. An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt index 7f6eb76980..c5308e6166 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt @@ -12,10 +12,7 @@ atlas api programmaticApiKeys createApiKeyAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates the access list entries for the specified organization API key. - -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. +Creates the access list entries for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. diff --git a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt index 17eb818b26..97c569eb3a 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt @@ -12,10 +12,7 @@ atlas api programmaticApiKeys createProjectApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates and assigns the specified organization API key to the specified project. - -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. +Creates and assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt index 0fd7e0b8f9..36777e4b3e 100644 --- a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt @@ -12,10 +12,7 @@ atlas api programmaticApiKeys deleteApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one organization API key from the specified organization. - -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. +Removes one organization API key from the specified organization. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt index 6861dd4278..595adcaf98 100644 --- a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt +++ b/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt @@ -12,10 +12,7 @@ atlas api programmaticApiKeys deleteApiKeyAccessListEntry :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes the specified access list entry from the specified organization API key. - -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. +Removes the specified access list entry from the specified organization API key. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt index 6bcfc5bd65..100764c58a 100644 --- a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt @@ -12,10 +12,7 @@ atlas api programmaticApiKeys getApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one organization API key. - -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. +Returns one organization API key. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt index f61221d3d0..b84be3b611 100644 --- a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt +++ b/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt @@ -12,10 +12,7 @@ atlas api programmaticApiKeys getApiKeyAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one access list entry for the specified organization API key. - -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. +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. diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt index 9efc5458dc..938118b3fa 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt @@ -12,10 +12,7 @@ atlas api programmaticApiKeys listApiKeyAccessListsEntries :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified organization API key. - -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. +Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt index 91d3bac2a3..cafef7876e 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt @@ -12,10 +12,7 @@ atlas api programmaticApiKeys listApiKeys :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all organization API keys for the specified organization. - -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. +Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt index 8082b5463c..b6c0497963 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt @@ -12,10 +12,7 @@ atlas api programmaticApiKeys listProjectApiKeys :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all organization API keys that you assigned to the specified project. - -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. +Returns all organization API keys that you assigned to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt index b0df2d311d..085afe7213 100644 --- a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt @@ -12,10 +12,7 @@ atlas api programmaticApiKeys removeProjectApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one organization API key from the specified project. - -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. +Removes one organization API key from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt index 1b8fbcfc10..7dbc02db05 100644 --- a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt @@ -12,10 +12,7 @@ atlas api programmaticApiKeys updateApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one organization API key in the specified organization. - -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. +Updates one organization API key in the specified organization. The organization API keys grant programmatic access to an organization. To use this resource, the requesting API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt index 34eee224cf..df7904ca50 100644 --- a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt +++ b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt @@ -12,10 +12,7 @@ atlas api programmaticApiKeys updateApiKeyRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the roles of the organization API key that you specify for the project that you specify. - -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. +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. diff --git a/docs/command/atlas-api-programmaticApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys.txt index e7f963ed8b..550632a4bd 100644 --- a/docs/command/atlas-api-programmaticApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys.txt @@ -12,10 +12,7 @@ atlas api programmaticApiKeys :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. - -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. +Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project. @@ -54,20 +51,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-programmaticApiKeys-addProjectApiKey` - `Public Preview: please provide feedback `_: Assigns the specified organization API key to the specified project. -* :ref:`atlas-api-programmaticApiKeys-createApiKey` - `Public Preview: please provide feedback `_: Creates one API key for the specified organization. -* :ref:`atlas-api-programmaticApiKeys-createApiKeyAccessList` - `Public Preview: please provide feedback `_: Creates the access list entries for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-createProjectApiKey` - `Public Preview: please provide feedback `_: Creates and assigns the specified organization API key to the specified project. -* :ref:`atlas-api-programmaticApiKeys-deleteApiKey` - `Public Preview: please provide feedback `_: Removes one organization API key from the specified organization. -* :ref:`atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry` - `Public Preview: please provide feedback `_: Removes the specified access list entry from the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-getApiKey` - `Public Preview: please provide feedback `_: Returns one organization API key. -* :ref:`atlas-api-programmaticApiKeys-getApiKeyAccessList` - `Public Preview: please provide feedback `_: Returns one access list entry for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries` - `Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-listApiKeys` - `Public Preview: please provide feedback `_: Returns all organization API keys for the specified organization. -* :ref:`atlas-api-programmaticApiKeys-listProjectApiKeys` - `Public Preview: please provide feedback `_: Returns all organization API keys that you assigned to the specified project. -* :ref:`atlas-api-programmaticApiKeys-removeProjectApiKey` - `Public Preview: please provide feedback `_: Removes one organization API key from the specified project. -* :ref:`atlas-api-programmaticApiKeys-updateApiKey` - `Public Preview: please provide feedback `_: Updates one organization API key in the specified organization. -* :ref:`atlas-api-programmaticApiKeys-updateApiKeyRoles` - `Public Preview: please provide feedback `_: Updates the roles of the organization API key that you specify for the project that you specify. +* :ref:`atlas-api-programmaticApiKeys-addProjectApiKey` - Assigns the specified organization API key to the specified project. +* :ref:`atlas-api-programmaticApiKeys-createApiKey` - Creates one API key for the specified organization. +* :ref:`atlas-api-programmaticApiKeys-createApiKeyAccessList` - Creates the access list entries for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-createProjectApiKey` - Creates and assigns the specified organization API key to the specified project. +* :ref:`atlas-api-programmaticApiKeys-deleteApiKey` - Removes one organization API key from the specified organization. +* :ref:`atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry` - Removes the specified access list entry from the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-getApiKey` - Returns one organization API key. +* :ref:`atlas-api-programmaticApiKeys-getApiKeyAccessList` - Returns one access list entry for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries` - Returns all access list entries that you configured for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-listApiKeys` - Returns all organization API keys for the specified organization. +* :ref:`atlas-api-programmaticApiKeys-listProjectApiKeys` - Returns all organization API keys that you assigned to the specified project. +* :ref:`atlas-api-programmaticApiKeys-removeProjectApiKey` - Removes one organization API key from the specified project. +* :ref:`atlas-api-programmaticApiKeys-updateApiKey` - Updates one organization API key in the specified organization. +* :ref:`atlas-api-programmaticApiKeys-updateApiKeyRoles` - Updates the roles of the organization API key that you specify for the project that you specify. .. toctree:: diff --git a/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt index d9630ba120..dbb7b8b834 100644 --- a/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt @@ -12,10 +12,7 @@ atlas api projectIpAccessList createProjectIpAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Adds one or more access list entries to the specified project. - -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. +Adds one or more access list entries to the specified project. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent POST requests. You must submit multiple POST requests synchronously. diff --git a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt index 8cc4e2f1fa..651ffe83cc 100644 --- a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt @@ -12,10 +12,7 @@ atlas api projectIpAccessList deleteProjectIpAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one access list entry from the specified project's IP access list. - -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. +Removes one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt index 0e5ea34acb..95936f5879 100644 --- a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt +++ b/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt @@ -12,10 +12,7 @@ atlas api projectIpAccessList getProjectIpAccessListStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the status of one project IP access list entry. - -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. +Returns the status of one project IP access list entry. This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt index 65e9d2535e..e3af08d688 100644 --- a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt +++ b/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt @@ -12,10 +12,7 @@ atlas api projectIpAccessList getProjectIpList :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one access list entry from the specified project's IP access list. - -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. +Returns one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. This endpoint (/groups/{GROUP-ID}/accessList) manages the Project IP Access List. It doesn't manage the access list for MongoDB Cloud organizations. TheProgrammatic API Keys endpoint (/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist) manages those access lists. diff --git a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt b/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt index d120d99cd5..a05ced6098 100644 --- a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt +++ b/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt @@ -12,10 +12,7 @@ atlas api projectIpAccessList listProjectIpAccessLists :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all access list entries from the specified project's IP access list. - -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. +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. diff --git a/docs/command/atlas-api-projectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList.txt index 37826ecffb..b82b4215a9 100644 --- a/docs/command/atlas-api-projectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList.txt @@ -12,10 +12,7 @@ atlas api projectIpAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes network access limits to database deployments in Atlas. - -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. +Returns, adds, edits, and removes network access limits to database deployments in Atlas. This resource replaces the whitelist resource. Atlas removed whitelists in July 2021. Update your applications to use this new resource. This resource manages a project's IP Access List and supports creating temporary Access List entries that automatically expire within a user-configurable 7-day period. @@ -54,11 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projectIpAccessList-createProjectIpAccessList` - `Public Preview: please provide feedback `_: Adds one or more access list entries to the specified project. -* :ref:`atlas-api-projectIpAccessList-deleteProjectIpAccessList` - `Public Preview: please provide feedback `_: Removes one access list entry from the specified project's IP access list. -* :ref:`atlas-api-projectIpAccessList-getProjectIpAccessListStatus` - `Public Preview: please provide feedback `_: Returns the status of one project IP access list entry. -* :ref:`atlas-api-projectIpAccessList-getProjectIpList` - `Public Preview: please provide feedback `_: Returns one access list entry from the specified project's IP access list. -* :ref:`atlas-api-projectIpAccessList-listProjectIpAccessLists` - `Public Preview: please provide feedback `_: Returns all access list entries from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-createProjectIpAccessList` - Adds one or more access list entries to the specified project. +* :ref:`atlas-api-projectIpAccessList-deleteProjectIpAccessList` - Removes one access list entry from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-getProjectIpAccessListStatus` - Returns the status of one project IP access list entry. +* :ref:`atlas-api-projectIpAccessList-getProjectIpList` - Returns one access list entry from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-listProjectIpAccessLists` - Returns all access list entries from the specified project's IP access list. .. toctree:: diff --git a/docs/command/atlas-api-projects-addUserToProject.txt b/docs/command/atlas-api-projects-addUserToProject.txt index 182bc943ce..4f8a48807b 100644 --- a/docs/command/atlas-api-projects-addUserToProject.txt +++ b/docs/command/atlas-api-projects-addUserToProject.txt @@ -12,10 +12,7 @@ atlas api projects addUserToProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to the specified project. - -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. +Adds one MongoDB Cloud user to the specified project. If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. diff --git a/docs/command/atlas-api-projects-createProject.txt b/docs/command/atlas-api-projects-createProject.txt index ac1f04409b..a2060ad7f6 100644 --- a/docs/command/atlas-api-projects-createProject.txt +++ b/docs/command/atlas-api-projects-createProject.txt @@ -12,10 +12,7 @@ atlas api projects createProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one project. - -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. +Creates one project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Read Write role. diff --git a/docs/command/atlas-api-projects-createProjectInvitation.txt b/docs/command/atlas-api-projects-createProjectInvitation.txt index 6b51c40577..f4fc05fc9a 100644 --- a/docs/command/atlas-api-projects-createProjectInvitation.txt +++ b/docs/command/atlas-api-projects-createProjectInvitation.txt @@ -12,10 +12,7 @@ atlas api projects createProjectInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Invites one MongoDB Cloud user to join the specified project. - -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. +Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-deleteProject.txt b/docs/command/atlas-api-projects-deleteProject.txt index 997fe6bbce..197da654db 100644 --- a/docs/command/atlas-api-projects-deleteProject.txt +++ b/docs/command/atlas-api-projects-deleteProject.txt @@ -12,10 +12,7 @@ atlas api projects deleteProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes the specified project. - -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. +Removes the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-deleteProjectInvitation.txt b/docs/command/atlas-api-projects-deleteProjectInvitation.txt index b278ce5454..6cb12632d4 100644 --- a/docs/command/atlas-api-projects-deleteProjectInvitation.txt +++ b/docs/command/atlas-api-projects-deleteProjectInvitation.txt @@ -12,10 +12,7 @@ atlas api projects deleteProjectInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. - -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. +Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-deleteProjectLimit.txt b/docs/command/atlas-api-projects-deleteProjectLimit.txt index faac32558f..058103b195 100644 --- a/docs/command/atlas-api-projects-deleteProjectLimit.txt +++ b/docs/command/atlas-api-projects-deleteProjectLimit.txt @@ -12,10 +12,7 @@ atlas api projects deleteProjectLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes the specified project limit. - -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. +Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-getProject.txt b/docs/command/atlas-api-projects-getProject.txt index 644c311e1c..18ac5d45ff 100644 --- a/docs/command/atlas-api-projects-getProject.txt +++ b/docs/command/atlas-api-projects-getProject.txt @@ -12,10 +12,7 @@ atlas api projects getProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details about the specified project. - -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. +Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-projects-getProjectByName.txt b/docs/command/atlas-api-projects-getProjectByName.txt index e908ca1b3c..d6aefce17a 100644 --- a/docs/command/atlas-api-projects-getProjectByName.txt +++ b/docs/command/atlas-api-projects-getProjectByName.txt @@ -12,10 +12,7 @@ atlas api projects getProjectByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details about the project identified by its name. - -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. +Returns details about the project identified by its name. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-projects-getProjectInvitation.txt b/docs/command/atlas-api-projects-getProjectInvitation.txt index 516f8130eb..d79fc0814b 100644 --- a/docs/command/atlas-api-projects-getProjectInvitation.txt +++ b/docs/command/atlas-api-projects-getProjectInvitation.txt @@ -12,10 +12,7 @@ atlas api projects getProjectInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the details of one pending invitation to the specified project. - -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. +Returns the details of one pending invitation to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-getProjectLimit.txt b/docs/command/atlas-api-projects-getProjectLimit.txt index 0dbaa1007f..706df2df74 100644 --- a/docs/command/atlas-api-projects-getProjectLimit.txt +++ b/docs/command/atlas-api-projects-getProjectLimit.txt @@ -12,10 +12,7 @@ atlas api projects getProjectLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the specified limit for the specified project. - -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. +Returns the specified limit for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-projects-getProjectLtsVersions.txt b/docs/command/atlas-api-projects-getProjectLtsVersions.txt index d2d76c2682..eab6c7735c 100644 --- a/docs/command/atlas-api-projects-getProjectLtsVersions.txt +++ b/docs/command/atlas-api-projects-getProjectLtsVersions.txt @@ -12,10 +12,7 @@ atlas api projects getProjectLtsVersions :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. - -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. +Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. 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-getprojectltsversions. diff --git a/docs/command/atlas-api-projects-getProjectSettings.txt b/docs/command/atlas-api-projects-getProjectSettings.txt index 98c61a2a69..89f703cd22 100644 --- a/docs/command/atlas-api-projects-getProjectSettings.txt +++ b/docs/command/atlas-api-projects-getProjectSettings.txt @@ -12,10 +12,7 @@ atlas api projects getProjectSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details about the specified project's settings. - -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. +Returns details about the specified project's settings. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-projects-listProjectInvitations.txt b/docs/command/atlas-api-projects-listProjectInvitations.txt index 0555601f85..ec1e2501e4 100644 --- a/docs/command/atlas-api-projects-listProjectInvitations.txt +++ b/docs/command/atlas-api-projects-listProjectInvitations.txt @@ -12,10 +12,7 @@ atlas api projects listProjectInvitations :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all pending invitations to the specified project. - -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. +Returns all pending invitations to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-listProjectLimits.txt b/docs/command/atlas-api-projects-listProjectLimits.txt index 9101ded3fb..0d68980db0 100644 --- a/docs/command/atlas-api-projects-listProjectLimits.txt +++ b/docs/command/atlas-api-projects-listProjectLimits.txt @@ -12,10 +12,7 @@ atlas api projects listProjectLimits :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all the limits for the specified project. - -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. +Returns all the limits for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-projects-listProjects.txt b/docs/command/atlas-api-projects-listProjects.txt index aa590eab5b..f04beb1f60 100644 --- a/docs/command/atlas-api-projects-listProjects.txt +++ b/docs/command/atlas-api-projects-listProjects.txt @@ -12,10 +12,7 @@ atlas api projects listProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details about all projects. - -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. +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. diff --git a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt b/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt index 1b17684c2f..89bcd50dfd 100644 --- a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt +++ b/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt @@ -12,10 +12,7 @@ atlas api projects migrateProjectToAnotherOrg :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Migrates a project from its current organization to another organization. - -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. +Migrates a project from its current organization to another organization. All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-projects-returnAllIpAddresses.txt b/docs/command/atlas-api-projects-returnAllIpAddresses.txt index d6ae34a02c..df8b6271f3 100644 --- a/docs/command/atlas-api-projects-returnAllIpAddresses.txt +++ b/docs/command/atlas-api-projects-returnAllIpAddresses.txt @@ -12,10 +12,7 @@ atlas api projects returnAllIpAddresses :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all IP addresses for this project. - -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. +Returns all IP addresses for this project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-projects-setProjectLimit.txt b/docs/command/atlas-api-projects-setProjectLimit.txt index df7aa391e3..6382368f73 100644 --- a/docs/command/atlas-api-projects-setProjectLimit.txt +++ b/docs/command/atlas-api-projects-setProjectLimit.txt @@ -12,10 +12,7 @@ atlas api projects setProjectLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Sets the specified project limit. - -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. +Sets the specified project limit. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-updateProject.txt b/docs/command/atlas-api-projects-updateProject.txt index 7ca4525d06..f89f9c693c 100644 --- a/docs/command/atlas-api-projects-updateProject.txt +++ b/docs/command/atlas-api-projects-updateProject.txt @@ -12,10 +12,7 @@ atlas api projects updateProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the human-readable label that identifies the specified project, or the tags associated with the project. - -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. +Updates the human-readable label that identifies the specified project, or the tags associated with the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-updateProjectInvitation.txt b/docs/command/atlas-api-projects-updateProjectInvitation.txt index 81bf7b07f1..73d9563076 100644 --- a/docs/command/atlas-api-projects-updateProjectInvitation.txt +++ b/docs/command/atlas-api-projects-updateProjectInvitation.txt @@ -12,10 +12,7 @@ atlas api projects updateProjectInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. - -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. +Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. To use this resource, the requesting API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-updateProjectInvitationById.txt b/docs/command/atlas-api-projects-updateProjectInvitationById.txt index 7c5a80b5e3..571a936002 100644 --- a/docs/command/atlas-api-projects-updateProjectInvitationById.txt +++ b/docs/command/atlas-api-projects-updateProjectInvitationById.txt @@ -12,10 +12,7 @@ atlas api projects updateProjectInvitationById :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by its unique ID, to the specified project. - -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. +Updates the details of one pending invitation, identified by its unique ID, to the specified project. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-updateProjectRoles.txt b/docs/command/atlas-api-projects-updateProjectRoles.txt index 3735b9ac22..d4f4ad6e0e 100644 --- a/docs/command/atlas-api-projects-updateProjectRoles.txt +++ b/docs/command/atlas-api-projects-updateProjectRoles.txt @@ -12,10 +12,7 @@ atlas api projects updateProjectRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the roles of the specified user in the specified project. - -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. +Updates the roles of the specified user in the specified project. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. diff --git a/docs/command/atlas-api-projects-updateProjectSettings.txt b/docs/command/atlas-api-projects-updateProjectSettings.txt index e6b41c5e07..5bd00c6f38 100644 --- a/docs/command/atlas-api-projects-updateProjectSettings.txt +++ b/docs/command/atlas-api-projects-updateProjectSettings.txt @@ -12,10 +12,7 @@ atlas api projects updateProjectSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the settings of the specified project. - -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. +Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects.txt b/docs/command/atlas-api-projects.txt index 8e2e8501eb..0d639c8436 100644 --- a/docs/command/atlas-api-projects.txt +++ b/docs/command/atlas-api-projects.txt @@ -12,12 +12,7 @@ atlas api projects :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. - -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. - - +Returns, adds, and edits collections of clusters and users in MongoDB Cloud. Options ------- @@ -54,29 +49,29 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projects-addUserToProject` - `Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to the specified project. -* :ref:`atlas-api-projects-createProject` - `Public Preview: please provide feedback `_: Creates one project. -* :ref:`atlas-api-projects-createProjectInvitation` - `Public Preview: please provide feedback `_: Invites one MongoDB Cloud user to join the specified project. -* :ref:`atlas-api-projects-deleteProject` - `Public Preview: please provide feedback `_: Removes the specified project. -* :ref:`atlas-api-projects-deleteProjectInvitation` - `Public Preview: please provide feedback `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. -* :ref:`atlas-api-projects-deleteProjectLimit` - `Public Preview: please provide feedback `_: Removes the specified project limit. -* :ref:`atlas-api-projects-getProject` - `Public Preview: please provide feedback `_: Returns details about the specified project. -* :ref:`atlas-api-projects-getProjectByName` - `Public Preview: please provide feedback `_: Returns details about the project identified by its name. -* :ref:`atlas-api-projects-getProjectInvitation` - `Public Preview: please provide feedback `_: Returns the details of one pending invitation to the specified project. -* :ref:`atlas-api-projects-getProjectLimit` - `Public Preview: please provide feedback `_: Returns the specified limit for the specified project. -* :ref:`atlas-api-projects-getProjectLtsVersions` - `Public Preview: please provide feedback `_: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. -* :ref:`atlas-api-projects-getProjectSettings` - `Public Preview: please provide feedback `_: Returns details about the specified project's settings. -* :ref:`atlas-api-projects-listProjectInvitations` - `Public Preview: please provide feedback `_: Returns all pending invitations to the specified project. -* :ref:`atlas-api-projects-listProjectLimits` - `Public Preview: please provide feedback `_: Returns all the limits for the specified project. -* :ref:`atlas-api-projects-listProjects` - `Public Preview: please provide feedback `_: Returns details about all projects. -* :ref:`atlas-api-projects-migrateProjectToAnotherOrg` - `Public Preview: please provide feedback `_: Migrates a project from its current organization to another organization. -* :ref:`atlas-api-projects-returnAllIpAddresses` - `Public Preview: please provide feedback `_: Returns all IP addresses for this project. -* :ref:`atlas-api-projects-setProjectLimit` - `Public Preview: please provide feedback `_: Sets the specified project limit. -* :ref:`atlas-api-projects-updateProject` - `Public Preview: please provide feedback `_: Updates the human-readable label that identifies the specified project, or the tags associated with the project. -* :ref:`atlas-api-projects-updateProjectInvitation` - `Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. -* :ref:`atlas-api-projects-updateProjectInvitationById` - `Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by its unique ID, to the specified project. -* :ref:`atlas-api-projects-updateProjectRoles` - `Public Preview: please provide feedback `_: Updates the roles of the specified user in the specified project. -* :ref:`atlas-api-projects-updateProjectSettings` - `Public Preview: please provide feedback `_: Updates the settings of the specified project. +* :ref:`atlas-api-projects-addUserToProject` - Adds one MongoDB Cloud user to the specified project. +* :ref:`atlas-api-projects-createProject` - Creates one project. +* :ref:`atlas-api-projects-createProjectInvitation` - Invites one MongoDB Cloud user to join the specified project. +* :ref:`atlas-api-projects-deleteProject` - Removes the specified project. +* :ref:`atlas-api-projects-deleteProjectInvitation` - Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. +* :ref:`atlas-api-projects-deleteProjectLimit` - Removes the specified project limit. +* :ref:`atlas-api-projects-getProject` - Returns details about the specified project. +* :ref:`atlas-api-projects-getProjectByName` - Returns details about the project identified by its name. +* :ref:`atlas-api-projects-getProjectInvitation` - Returns the details of one pending invitation to the specified project. +* :ref:`atlas-api-projects-getProjectLimit` - Returns the specified limit for the specified project. +* :ref:`atlas-api-projects-getProjectLtsVersions` - Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. +* :ref:`atlas-api-projects-getProjectSettings` - Returns details about the specified project's settings. +* :ref:`atlas-api-projects-listProjectInvitations` - Returns all pending invitations to the specified project. +* :ref:`atlas-api-projects-listProjectLimits` - Returns all the limits for the specified project. +* :ref:`atlas-api-projects-listProjects` - Returns details about all projects. +* :ref:`atlas-api-projects-migrateProjectToAnotherOrg` - Migrates a project from its current organization to another organization. +* :ref:`atlas-api-projects-returnAllIpAddresses` - Returns all IP addresses for this project. +* :ref:`atlas-api-projects-setProjectLimit` - Sets the specified project limit. +* :ref:`atlas-api-projects-updateProject` - Updates the human-readable label that identifies the specified project, or the tags associated with the project. +* :ref:`atlas-api-projects-updateProjectInvitation` - Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. +* :ref:`atlas-api-projects-updateProjectInvitationById` - Updates the details of one pending invitation, identified by its unique ID, to the specified project. +* :ref:`atlas-api-projects-updateProjectRoles` - Updates the roles of the specified user in the specified project. +* :ref:`atlas-api-projects-updateProjectSettings` - Updates the settings of the specified project. .. toctree:: diff --git a/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt index 984ba6b066..ab0c25c2f5 100644 --- a/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt @@ -12,10 +12,7 @@ atlas api pushBasedLogExport createPushBasedLogConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Configures the project level settings for the push-based log export feature. - -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. +Configures the project level settings for the push-based log export feature. 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-createpushbasedlogconfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt index 093f6e2790..0f6134e110 100644 --- a/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt @@ -12,10 +12,7 @@ atlas api pushBasedLogExport deletePushBasedLogConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Disables the push-based log export feature by resetting the project level settings to its default configuration. - -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. +Disables the push-based log export feature by resetting the project level settings to its default configuration. 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-deletepushbasedlogconfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt index c7b6ff3158..0a233c51c6 100644 --- a/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt @@ -12,10 +12,7 @@ atlas api pushBasedLogExport getPushBasedLogConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Fetches the current project level settings for the push-based log export feature. - -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. +Fetches the current project level settings for the push-based log export feature. 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-getpushbasedlogconfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt index c67865b591..ff67b68b11 100644 --- a/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt @@ -12,10 +12,7 @@ atlas api pushBasedLogExport updatePushBasedLogConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the project level settings for the push-based log export feature. - -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. +Updates the project level settings for the push-based log export feature. 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-updatepushbasedlogconfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport.txt b/docs/command/atlas-api-pushBasedLogExport.txt index ddfafcf669..681ae65512 100644 --- a/docs/command/atlas-api-pushBasedLogExport.txt +++ b/docs/command/atlas-api-pushBasedLogExport.txt @@ -12,10 +12,7 @@ atlas api pushBasedLogExport :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. - -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 continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes. @@ -54,10 +51,10 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-pushBasedLogExport-createPushBasedLogConfiguration` - `Public Preview: please provide feedback `_: Configures the project level settings for the push-based log export feature. -* :ref:`atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration` - `Public Preview: please provide feedback `_: Disables the push-based log export feature by resetting the project level settings to its default configuration. -* :ref:`atlas-api-pushBasedLogExport-getPushBasedLogConfiguration` - `Public Preview: please provide feedback `_: Fetches the current project level settings for the push-based log export feature. -* :ref:`atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration` - `Public Preview: please provide feedback `_: Updates the project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-createPushBasedLogConfiguration` - Configures the project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration` - Disables the push-based log export feature by resetting the project level settings to its default configuration. +* :ref:`atlas-api-pushBasedLogExport-getPushBasedLogConfiguration` - Fetches the current project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration` - Updates the project level settings for the push-based log export feature. .. toctree:: diff --git a/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt b/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt index 795eade289..241912541b 100644 --- a/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt +++ b/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt @@ -12,10 +12,7 @@ atlas api queryShapeInsights getGroupClusterQueryShapeInsightDetails :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the metadata and statistics summary for a given query shape hash. - -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. +Returns the metadata and statistics summary for a given query shape hash. 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-getgroupclusterqueryshapeinsightdetails. diff --git a/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries.txt b/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries.txt index f61a0f7c3b..1321149220 100644 --- a/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries.txt +++ b/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries.txt @@ -12,10 +12,7 @@ atlas api queryShapeInsights getGroupClusterQueryShapeInsightSummaries :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns a list of query shape statistics summaries for a given cluster. - -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. +Returns a list of query shape statistics summaries for a given cluster. Query shape statistics provide performance insights about MongoDB queries, helping users identify problematic query patterns and potential optimizations. diff --git a/docs/command/atlas-api-queryShapeInsights.txt b/docs/command/atlas-api-queryShapeInsights.txt index 8aa62bb13b..71ad351fd5 100644 --- a/docs/command/atlas-api-queryShapeInsights.txt +++ b/docs/command/atlas-api-queryShapeInsights.txt @@ -12,11 +12,6 @@ atlas api queryShapeInsights :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: - -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. - Options @@ -54,8 +49,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails` - `Public Preview: please provide feedback `_: Returns the metadata and statistics summary for a given query shape hash. -* :ref:`atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries` - `Public Preview: please provide feedback `_: Returns a list of query shape statistics summaries for a given cluster. +* :ref:`atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails` - Returns the metadata and statistics summary for a given query shape hash. +* :ref:`atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries` - Returns a list of query shape statistics summaries for a given cluster. .. toctree:: diff --git a/docs/command/atlas-api-resourcePolicies-createOrgResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-createOrgResourcePolicy.txt index a1090619b6..b45bc7257c 100644 --- a/docs/command/atlas-api-resourcePolicies-createOrgResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-createOrgResourcePolicy.txt @@ -12,10 +12,7 @@ atlas api resourcePolicies createOrgResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Create one Atlas Resource Policy for an org. - -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. +Create one Atlas Resource Policy for an org. 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-createorgresourcepolicy. diff --git a/docs/command/atlas-api-resourcePolicies-deleteOrgResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-deleteOrgResourcePolicy.txt index 5f45e328d6..0d3ccfb3bb 100644 --- a/docs/command/atlas-api-resourcePolicies-deleteOrgResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-deleteOrgResourcePolicy.txt @@ -12,10 +12,7 @@ atlas api resourcePolicies deleteOrgResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Delete one Atlas Resource Policy for an org. - -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. +Delete one Atlas Resource Policy for an org. 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-deleteorgresourcepolicy. diff --git a/docs/command/atlas-api-resourcePolicies-getOrgResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-getOrgResourcePolicy.txt index 6f9317dc16..adc9ba5449 100644 --- a/docs/command/atlas-api-resourcePolicies-getOrgResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-getOrgResourcePolicy.txt @@ -12,10 +12,7 @@ atlas api resourcePolicies getOrgResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Return one Atlas Resource Policy for an org. - -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. +Return one Atlas Resource Policy for an org. 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-getorgresourcepolicy. diff --git a/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt b/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt index 51b3e1f8e8..4fbd2f54c9 100644 --- a/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt +++ b/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt @@ -12,10 +12,7 @@ atlas api resourcePolicies getResourcesNonCompliant :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Return all non-compliant resources for an org. - -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. +Return all non-compliant resources for an org. 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-getresourcesnoncompliant. diff --git a/docs/command/atlas-api-resourcePolicies-listOrgResourcePolicies.txt b/docs/command/atlas-api-resourcePolicies-listOrgResourcePolicies.txt index c634310886..8894e99da9 100644 --- a/docs/command/atlas-api-resourcePolicies-listOrgResourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies-listOrgResourcePolicies.txt @@ -12,10 +12,7 @@ atlas api resourcePolicies listOrgResourcePolicies :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Return all Atlas Resource Policies for the org. - -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. +Return all Atlas Resource Policies for the org. 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-listorgresourcepolicies. diff --git a/docs/command/atlas-api-resourcePolicies-updateOrgResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-updateOrgResourcePolicy.txt index 758745f15a..99aa42b6aa 100644 --- a/docs/command/atlas-api-resourcePolicies-updateOrgResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-updateOrgResourcePolicy.txt @@ -12,10 +12,7 @@ atlas api resourcePolicies updateOrgResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Update one Atlas Resource Policy for an org. - -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. +Update one Atlas Resource Policy for an org. 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-updateorgresourcepolicy. diff --git a/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt index d34aca07b8..c4c1e0dd63 100644 --- a/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt @@ -12,10 +12,7 @@ atlas api resourcePolicies validateAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Validate one Atlas Resource Policy for an org. - -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. +Validate one Atlas Resource Policy for an org. 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-validateatlasresourcepolicy. diff --git a/docs/command/atlas-api-resourcePolicies.txt b/docs/command/atlas-api-resourcePolicies.txt index 6d8d4e3537..3ec715b776 100644 --- a/docs/command/atlas-api-resourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies.txt @@ -12,12 +12,7 @@ atlas api resourcePolicies :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Configure and manage Atlas Resource Policies within your organization. - -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. - - +Configure and manage Atlas Resource Policies within your organization. Options ------- @@ -54,13 +49,13 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-resourcePolicies-createOrgResourcePolicy` - `Public Preview: please provide feedback `_: Create one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-deleteOrgResourcePolicy` - `Public Preview: please provide feedback `_: Delete one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getOrgResourcePolicy` - `Public Preview: please provide feedback `_: Return one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getResourcesNonCompliant` - `Public Preview: please provide feedback `_: Return all non-compliant resources for an org. -* :ref:`atlas-api-resourcePolicies-listOrgResourcePolicies` - `Public Preview: please provide feedback `_: Return all Atlas Resource Policies for the org. -* :ref:`atlas-api-resourcePolicies-updateOrgResourcePolicy` - `Public Preview: please provide feedback `_: Update one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-validateAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Validate one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-createOrgResourcePolicy` - Create one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-deleteOrgResourcePolicy` - Delete one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-getOrgResourcePolicy` - Return one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-getResourcesNonCompliant` - Return all non-compliant resources for an org. +* :ref:`atlas-api-resourcePolicies-listOrgResourcePolicies` - Return all Atlas Resource Policies for the org. +* :ref:`atlas-api-resourcePolicies-updateOrgResourcePolicy` - Update one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-validateAtlasResourcePolicy` - Validate one Atlas Resource Policy for an org. .. toctree:: diff --git a/docs/command/atlas-api-rollingIndex-createRollingIndex.txt b/docs/command/atlas-api-rollingIndex-createRollingIndex.txt index 719c820d85..f592281958 100644 --- a/docs/command/atlas-api-rollingIndex-createRollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex-createRollingIndex.txt @@ -12,10 +12,7 @@ atlas api rollingIndex createRollingIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates an index on the cluster identified by its name in a rolling manner. - -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. +Creates an index on the cluster identified by its name in a rolling manner. Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-rollingIndex.txt b/docs/command/atlas-api-rollingIndex.txt index 56cbda56f4..2f84fc5ce0 100644 --- a/docs/command/atlas-api-rollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex.txt @@ -12,10 +12,7 @@ atlas api rollingIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one index to a database deployment in a rolling manner. - -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. +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. @@ -54,7 +51,7 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-rollingIndex-createRollingIndex` - `Public Preview: please provide feedback `_: Creates an index on the cluster identified by its name in a rolling manner. +* :ref:`atlas-api-rollingIndex-createRollingIndex` - Creates an index on the cluster identified by its name in a rolling manner. .. toctree:: diff --git a/docs/command/atlas-api-root-getSystemStatus.txt b/docs/command/atlas-api-root-getSystemStatus.txt index 14de0e6164..e0bfad2969 100644 --- a/docs/command/atlas-api-root-getSystemStatus.txt +++ b/docs/command/atlas-api-root-getSystemStatus.txt @@ -12,10 +12,7 @@ atlas api root getSystemStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: This resource returns information about the MongoDB application along with API key meta data. - -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. +This resource returns information about the MongoDB application along with API key meta data. 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-getsystemstatus. diff --git a/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt b/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt index 9b4e9dea7b..fa166ec9e2 100644 --- a/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt +++ b/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt @@ -12,10 +12,7 @@ atlas api root returnAllControlPlaneIpAddresses :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all control plane IP addresses. - -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. +Returns all control plane IP addresses. 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-returnallcontrolplaneipaddresses. diff --git a/docs/command/atlas-api-root.txt b/docs/command/atlas-api-root.txt index 67d2f2e32d..00f2658f32 100644 --- a/docs/command/atlas-api-root.txt +++ b/docs/command/atlas-api-root.txt @@ -12,10 +12,7 @@ atlas api root :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. - -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. +Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API. @@ -54,8 +51,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-root-getSystemStatus` - `Public Preview: please provide feedback `_: This resource returns information about the MongoDB application along with API key meta data. -* :ref:`atlas-api-root-returnAllControlPlaneIpAddresses` - `Public Preview: please provide feedback `_: Returns all control plane IP addresses. +* :ref:`atlas-api-root-getSystemStatus` - This resource returns information about the MongoDB application along with API key meta data. +* :ref:`atlas-api-root-returnAllControlPlaneIpAddresses` - Returns all control plane IP addresses. .. toctree:: diff --git a/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt index 03cd6e46cf..b5ab0cd2bb 100644 --- a/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt @@ -12,10 +12,7 @@ atlas api serverlessInstances createServerlessInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Update as of Feb 2025: This endpoint now creates a Flex cluster instead. - -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. +Update as of Feb 2025: This endpoint now creates a Flex cluster instead. This endpoint will no longer be supported starting January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect. Please use the createFlexCluster endpoint instead. diff --git a/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt index 22b0c71e1c..47ed45df61 100644 --- a/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt @@ -12,10 +12,7 @@ atlas api serverlessInstances deleteServerlessInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one serverless instance from the specified project. - -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. +Removes one serverless instance from the specified project. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt index 955b148798..7a6d6acf4b 100644 --- a/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt @@ -12,10 +12,7 @@ atlas api serverlessInstances getServerlessInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details for one serverless instance in the specified project. - -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. +Returns details for one serverless instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt b/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt index 01c9ed7829..7334eba6aa 100644 --- a/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt +++ b/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt @@ -12,10 +12,7 @@ atlas api serverlessInstances listServerlessInstances :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details for all serverless instances in the specified project. - -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. +Returns details for all serverless instances in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt index 0351e4f0ff..57fe53978a 100644 --- a/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt @@ -12,10 +12,7 @@ atlas api serverlessInstances updateServerlessInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one serverless instance in the specified project. - -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. +Updates one serverless instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessInstances.txt b/docs/command/atlas-api-serverlessInstances.txt index 36c57106e1..1b20516e01 100644 --- a/docs/command/atlas-api-serverlessInstances.txt +++ b/docs/command/atlas-api-serverlessInstances.txt @@ -12,12 +12,7 @@ atlas api serverlessInstances :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes serverless instances. - -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. - - +Returns, adds, edits, and removes serverless instances. Options ------- @@ -54,11 +49,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serverlessInstances-createServerlessInstance` - `Public Preview: please provide feedback `_: Update as of Feb 2025: This endpoint now creates a Flex cluster instead. -* :ref:`atlas-api-serverlessInstances-deleteServerlessInstance` - `Public Preview: please provide feedback `_: Removes one serverless instance from the specified project. -* :ref:`atlas-api-serverlessInstances-getServerlessInstance` - `Public Preview: please provide feedback `_: Returns details for one serverless instance in the specified project. -* :ref:`atlas-api-serverlessInstances-listServerlessInstances` - `Public Preview: please provide feedback `_: Returns details for all serverless instances in the specified project. -* :ref:`atlas-api-serverlessInstances-updateServerlessInstance` - `Public Preview: please provide feedback `_: Updates one serverless instance in the specified project. +* :ref:`atlas-api-serverlessInstances-createServerlessInstance` - Update as of Feb 2025: This endpoint now creates a Flex cluster instead. +* :ref:`atlas-api-serverlessInstances-deleteServerlessInstance` - Removes one serverless instance from the specified project. +* :ref:`atlas-api-serverlessInstances-getServerlessInstance` - Returns details for one serverless instance in the specified project. +* :ref:`atlas-api-serverlessInstances-listServerlessInstances` - Returns details for all serverless instances in the specified project. +* :ref:`atlas-api-serverlessInstances-updateServerlessInstance` - Updates one serverless instance in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt index c5bd612603..80baea5741 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt @@ -12,10 +12,7 @@ atlas api serverlessPrivateEndpoints createServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one private endpoint for one serverless instance. - -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. +Creates one private endpoint for one serverless instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt index 58a1a9488f..a35db2ae11 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt @@ -12,10 +12,7 @@ atlas api serverlessPrivateEndpoints deleteServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Remove one private endpoint from one serverless instance. - -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. +Remove one private endpoint from one serverless instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt index ed322f1146..aa27d86010 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt @@ -12,10 +12,7 @@ atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Return one private endpoint for one serverless instance. - -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. +Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt index 1c9e8225f0..59738432ca 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt @@ -12,10 +12,7 @@ atlas api serverlessPrivateEndpoints listServerlessPrivateEndpoints :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all private endpoints for one serverless instance. - -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. +Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt index a8163382aa..2c72dce4b1 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt @@ -12,10 +12,7 @@ atlas api serverlessPrivateEndpoints updateServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one private endpoint for one serverless instance. - -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. +Updates one private endpoint for one serverless instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints.txt b/docs/command/atlas-api-serverlessPrivateEndpoints.txt index 712bc39b39..5bbbd72a5f 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints.txt @@ -12,10 +12,7 @@ atlas api serverlessPrivateEndpoints :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes private endpoints for serverless instances. - -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. +Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial. @@ -54,11 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint` - `Public Preview: please provide feedback `_: Creates one private endpoint for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint` - `Public Preview: please provide feedback `_: Remove one private endpoint from one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint` - `Public Preview: please provide feedback `_: Return one private endpoint for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints` - `Public Preview: please provide feedback `_: Returns all private endpoints for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint` - `Public Preview: please provide feedback `_: Updates one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint` - Creates one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint` - Remove one private endpoint from one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint` - Return one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints` - Returns all private endpoints for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint` - Updates one private endpoint for one serverless instance. .. toctree:: diff --git a/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt index a2600ac471..92909c0310 100644 --- a/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts addProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Assigns the specified Service Account to the specified Project. - -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. +Assigns the specified Service Account to the specified Project. 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-addprojectserviceaccount. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt index 4791ce6352..293f55c912 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts createProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one Service Account for the specified Project. - -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. +Creates one Service Account for the specified Project. The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt index 036bfef5e0..5fc27e6217 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts createProjectServiceAccountAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Add Access List Entries for the specified Service Account for the project. - -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. +Add Access List Entries for the specified Service Account for the project. Resources require all API requests to originate from IP addresses on the API access list. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt index 29370926b6..6596f43fb7 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts createProjectServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Create a secret for the specified Service Account in the specified Project. - -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. +Create a secret for the specified Service Account in the specified Project. 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-createprojectserviceaccountsecret. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt index 3a66468d61..5034f1632d 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts createServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one Service Account for the specified Organization. - -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. +Creates one Service Account for the specified Organization. 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-createserviceaccount. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt index 7b6a464945..11eeb30f0e 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts createServiceAccountAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Add Access List Entries for the specified Service Account for the organization. - -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. +Add Access List Entries for the specified Service Account for the organization. Resources require all API requests to originate from IP addresses on the API access list. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt index bdfdf7f3f7..4e17601bbe 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts createServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Create a secret for the specified Service Account. - -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. +Create a secret for the specified Service Account. 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-createserviceaccountsecret. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt index 238957ffb0..c126719485 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts deleteProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes the specified Service Account from the specified project. - -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. +Removes the specified Service Account from the specified project. The Service Account will still be a part of the Organization it was created in, and the credentials will remain active until expired or manually revoked. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt index 74ee28ff84..66c9dd3a55 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts deleteProjectServiceAccountAccessListEntry :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes the specified access list entry from the specified Service Account for the project. - -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. +Removes the specified access list entry from the specified Service Account for the project. You can't remove the requesting IP address from the access list. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt index afcc6335fa..5c8384b50a 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts deleteProjectServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes the specified Service Account secret. - -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. +Deletes the specified Service Account secret. 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-deleteprojectserviceaccountsecret. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt index cbd4396190..ee39b95d77 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts deleteServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes the specified Service Account. - -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. +Deletes the specified Service Account. 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-deleteserviceaccount. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt index 385906c69d..2168e11c57 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts deleteServiceAccountAccessListEntry :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes the specified access list entry from the specified Service Account for the organization. - -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. +Removes the specified access list entry from the specified Service Account for the organization. You can't remove the requesting IP address from the access list. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt index fb485459ca..1872eebbd3 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts deleteServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes the specified Service Account secret. - -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. +Deletes the specified Service Account secret. 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-deleteserviceaccountsecret. diff --git a/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt index 26d5c7e87e..c17afa1b40 100644 --- a/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts getProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one Service Account in the specified Project. - -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. +Returns one Service Account in the specified Project. 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-getprojectserviceaccount. diff --git a/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt index 0d8532b1cb..08ce892ba9 100644 --- a/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts getServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the specified Service Account. - -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. +Returns the specified Service Account. 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-getserviceaccount. diff --git a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt index c797f1e5f0..fef90b3a1c 100644 --- a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts listProjectServiceAccountAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified Service Account for the project. - -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. +Returns all access list entries that you configured for the specified Service Account for the project. 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-listprojectserviceaccountaccesslist. diff --git a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt index 983f86171c..2bd9398b77 100644 --- a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts listProjectServiceAccounts :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all Service Accounts for the specified Project. - -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. +Returns all Service Accounts for the specified Project. 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-listprojectserviceaccounts. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt index 53b20167f2..5d13cbef93 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts listServiceAccountAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified Service Account for the organization. - -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. +Returns all access list entries that you configured for the specified Service Account for the organization. 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-listserviceaccountaccesslist. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt index 92e17db425..5841c503a5 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts listServiceAccountProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns a list of all projects the specified Service Account is a part of. - -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. +Returns a list of all projects the specified Service Account is a part of. 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-listserviceaccountprojects. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt index 163c286179..30e5bbc1be 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts listServiceAccounts :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all Service Accounts for the specified Organization. - -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. +Returns all Service Accounts for the specified Organization. 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-listserviceaccounts. diff --git a/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt index 07b2363bf7..82b31d1129 100644 --- a/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts updateProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one Service Account in the specified Project. - -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. +Updates one Service Account in the specified Project. 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-updateprojectserviceaccount. diff --git a/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt index 8496481e24..8ff26fac2d 100644 --- a/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts updateServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the specified Service Account in the specified Organization. - -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. +Updates the specified Service Account in the specified Organization. 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-updateserviceaccount. diff --git a/docs/command/atlas-api-serviceAccounts.txt b/docs/command/atlas-api-serviceAccounts.txt index 3029a8904e..8c9d2b0037 100644 --- a/docs/command/atlas-api-serviceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts.txt @@ -12,10 +12,7 @@ atlas api serviceAccounts :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Endpoints for managing Service Accounts and secrets. - -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. +Endpoints for managing Service Accounts and secrets. Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow. @@ -54,28 +51,28 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serviceAccounts-addProjectServiceAccount` - `Public Preview: please provide feedback `_: Assigns the specified Service Account to the specified Project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccount` - `Public Preview: please provide feedback `_: Creates one Service Account for the specified Project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountAccessList` - `Public Preview: please provide feedback `_: Add Access List Entries for the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountSecret` - `Public Preview: please provide feedback `_: Create a secret for the specified Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-createServiceAccount` - `Public Preview: please provide feedback `_: Creates one Service Account for the specified Organization. -* :ref:`atlas-api-serviceAccounts-createServiceAccountAccessList` - `Public Preview: please provide feedback `_: Add Access List Entries for the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-createServiceAccountSecret` - `Public Preview: please provide feedback `_: Create a secret for the specified Service Account. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccount` - `Public Preview: please provide feedback `_: Removes the specified Service Account from the specified project. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry` - `Public Preview: please provide feedback `_: Removes the specified access list entry from the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountSecret` - `Public Preview: please provide feedback `_: Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccount` - `Public Preview: please provide feedback `_: Deletes the specified Service Account. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry` - `Public Preview: please provide feedback `_: Removes the specified access list entry from the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccountSecret` - `Public Preview: please provide feedback `_: Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-getProjectServiceAccount` - `Public Preview: please provide feedback `_: Returns one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-getServiceAccount` - `Public Preview: please provide feedback `_: Returns the specified Service Account. -* :ref:`atlas-api-serviceAccounts-listProjectServiceAccountAccessList` - `Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-listProjectServiceAccounts` - `Public Preview: please provide feedback `_: Returns all Service Accounts for the specified Project. -* :ref:`atlas-api-serviceAccounts-listServiceAccountAccessList` - `Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-listServiceAccountProjects` - `Public Preview: please provide feedback `_: Returns a list of all projects the specified Service Account is a part of. -* :ref:`atlas-api-serviceAccounts-listServiceAccounts` - `Public Preview: please provide feedback `_: Returns all Service Accounts for the specified Organization. -* :ref:`atlas-api-serviceAccounts-updateProjectServiceAccount` - `Public Preview: please provide feedback `_: Updates one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-updateServiceAccount` - `Public Preview: please provide feedback `_: Updates the specified Service Account in the specified Organization. +* :ref:`atlas-api-serviceAccounts-addProjectServiceAccount` - Assigns the specified Service Account to the specified Project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccount` - Creates one Service Account for the specified Project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountAccessList` - Add Access List Entries for the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountSecret` - Create a secret for the specified Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-createServiceAccount` - Creates one Service Account for the specified Organization. +* :ref:`atlas-api-serviceAccounts-createServiceAccountAccessList` - Add Access List Entries for the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-createServiceAccountSecret` - Create a secret for the specified Service Account. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccount` - Removes the specified Service Account from the specified project. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry` - Removes the specified access list entry from the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountSecret` - Deletes the specified Service Account secret. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccount` - Deletes the specified Service Account. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry` - Removes the specified access list entry from the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccountSecret` - Deletes the specified Service Account secret. +* :ref:`atlas-api-serviceAccounts-getProjectServiceAccount` - Returns one Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-getServiceAccount` - Returns the specified Service Account. +* :ref:`atlas-api-serviceAccounts-listProjectServiceAccountAccessList` - Returns all access list entries that you configured for the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-listProjectServiceAccounts` - Returns all Service Accounts for the specified Project. +* :ref:`atlas-api-serviceAccounts-listServiceAccountAccessList` - Returns all access list entries that you configured for the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-listServiceAccountProjects` - Returns a list of all projects the specified Service Account is a part of. +* :ref:`atlas-api-serviceAccounts-listServiceAccounts` - Returns all Service Accounts for the specified Organization. +* :ref:`atlas-api-serviceAccounts-updateProjectServiceAccount` - Updates one Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-updateServiceAccount` - Updates the specified Service Account in the specified Organization. .. toctree:: diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt b/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt index fc0cf174cf..a156451f58 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt @@ -12,10 +12,7 @@ atlas api sharedTierRestoreJobs createSharedClusterBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Restores the specified M2 or M5 cluster. - -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. +Restores the specified M2 or M5 cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt b/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt index bc0a98933c..b605703043 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt @@ -12,10 +12,7 @@ atlas api sharedTierRestoreJobs getSharedClusterBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the specified restore job for the specified M2 or M5 cluster. - -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. +Returns the specified restore job for the specified M2 or M5 cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt b/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt index 169f534980..83718b668c 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt @@ -12,10 +12,7 @@ atlas api sharedTierRestoreJobs listSharedClusterBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all restore jobs for the specified M2 or M5 cluster. - -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. +Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-sharedTierRestoreJobs.txt b/docs/command/atlas-api-sharedTierRestoreJobs.txt index f6bd328115..92bc4c2959 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs.txt @@ -12,12 +12,7 @@ atlas api sharedTierRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns and adds restore jobs for shared-tier database deployments. - -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. - - +Returns and adds restore jobs for shared-tier database deployments. Options ------- @@ -54,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores the specified M2 or M5 cluster. -* :ref:`atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob` - `Public Preview: please provide feedback `_: Returns the specified restore job for the specified M2 or M5 cluster. -* :ref:`atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs` - `Public Preview: please provide feedback `_: Returns all restore jobs for the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob` - Restores the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob` - Returns the specified restore job for the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs` - Returns all restore jobs for the specified M2 or M5 cluster. .. toctree:: diff --git a/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt b/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt index 3995b61f2c..65168c0c94 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt @@ -12,10 +12,7 @@ atlas api sharedTierSnapshots downloadSharedClusterBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Requests one snapshot for the specified shared cluster. - -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. +Requests one snapshot for the specified shared cluster. This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt b/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt index d40ea4ac7b..b1c1b49d47 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt @@ -12,10 +12,7 @@ atlas api sharedTierSnapshots getSharedClusterBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details for one snapshot for the specified shared cluster. - -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. +Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt b/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt index 89db5a6a04..43c7110be2 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt @@ -12,10 +12,7 @@ atlas api sharedTierSnapshots listSharedClusterBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details for all snapshots for the specified shared cluster. - -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. +Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-sharedTierSnapshots.txt b/docs/command/atlas-api-sharedTierSnapshots.txt index f17a3e93d3..8c902f18e3 100644 --- a/docs/command/atlas-api-sharedTierSnapshots.txt +++ b/docs/command/atlas-api-sharedTierSnapshots.txt @@ -12,12 +12,7 @@ atlas api sharedTierSnapshots :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns and requests to download shared-tier database deployment snapshots. - -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. - - +Returns and requests to download shared-tier database deployment snapshots. Options ------- @@ -54,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierSnapshots-downloadSharedClusterBackup` - `Public Preview: please provide feedback `_: Requests one snapshot for the specified shared cluster. -* :ref:`atlas-api-sharedTierSnapshots-getSharedClusterBackup` - `Public Preview: please provide feedback `_: Returns details for one snapshot for the specified shared cluster. -* :ref:`atlas-api-sharedTierSnapshots-listSharedClusterBackups` - `Public Preview: please provide feedback `_: Returns details for all snapshots for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-downloadSharedClusterBackup` - Requests one snapshot for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-getSharedClusterBackup` - Returns details for one snapshot for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-listSharedClusterBackups` - Returns details for all snapshots for the specified shared cluster. .. toctree:: diff --git a/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt b/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt index 2198d24ef3..c1c69255c2 100644 --- a/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt @@ -12,10 +12,7 @@ atlas api streams acceptVpcPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Requests the acceptance of an incoming VPC Peering connection. - -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. +Requests the acceptance of an incoming VPC Peering connection. 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-acceptvpcpeeringconnection. diff --git a/docs/command/atlas-api-streams-createPrivateLinkConnection.txt b/docs/command/atlas-api-streams-createPrivateLinkConnection.txt index cceb8f3186..375f441502 100644 --- a/docs/command/atlas-api-streams-createPrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-createPrivateLinkConnection.txt @@ -12,10 +12,7 @@ atlas api streams createPrivateLinkConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one Private Link in the specified project. - -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. +Creates one Private Link in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-createStreamConnection.txt b/docs/command/atlas-api-streams-createStreamConnection.txt index a1bd998485..28c658b1b9 100644 --- a/docs/command/atlas-api-streams-createStreamConnection.txt +++ b/docs/command/atlas-api-streams-createStreamConnection.txt @@ -12,10 +12,7 @@ atlas api streams createStreamConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one connection for a stream instance in the specified project. - -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. +Creates one connection for a stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-createStreamInstance.txt b/docs/command/atlas-api-streams-createStreamInstance.txt index bc299ac7ff..ea81567c81 100644 --- a/docs/command/atlas-api-streams-createStreamInstance.txt +++ b/docs/command/atlas-api-streams-createStreamInstance.txt @@ -12,10 +12,7 @@ atlas api streams createStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one stream instance in the specified project. - -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. +Creates one stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt b/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt index fcfdc80a2f..f8ec21c4f3 100644 --- a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt +++ b/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt @@ -12,10 +12,7 @@ atlas api streams createStreamInstanceWithSampleConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one stream instance in the specified project with sample connections. - -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. +Creates one stream instance in the specified project with sample connections. To use this resource the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-createStreamProcessor.txt b/docs/command/atlas-api-streams-createStreamProcessor.txt index efaff9c7d9..dd3432daa4 100644 --- a/docs/command/atlas-api-streams-createStreamProcessor.txt +++ b/docs/command/atlas-api-streams-createStreamProcessor.txt @@ -12,10 +12,7 @@ atlas api streams createStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Create one Stream Processor within the specified stream instance. - -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. +Create one Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt index 0db1e34da0..86bfcc979f 100644 --- a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt @@ -12,10 +12,7 @@ atlas api streams deletePrivateLinkConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes one Private Link in the specified project. - -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. +Deletes one Private Link in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-deleteStreamConnection.txt b/docs/command/atlas-api-streams-deleteStreamConnection.txt index 7f914fed72..5c3b49fdc7 100644 --- a/docs/command/atlas-api-streams-deleteStreamConnection.txt +++ b/docs/command/atlas-api-streams-deleteStreamConnection.txt @@ -12,10 +12,7 @@ atlas api streams deleteStreamConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Delete one connection of the specified stream instance. - -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. +Delete one connection of the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-deleteStreamInstance.txt b/docs/command/atlas-api-streams-deleteStreamInstance.txt index c558f4e57c..45d959c8db 100644 --- a/docs/command/atlas-api-streams-deleteStreamInstance.txt +++ b/docs/command/atlas-api-streams-deleteStreamInstance.txt @@ -12,10 +12,7 @@ atlas api streams deleteStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Delete one stream instance in the specified project. - -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. +Delete one stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-deleteStreamProcessor.txt b/docs/command/atlas-api-streams-deleteStreamProcessor.txt index d2774f544f..c91f192826 100644 --- a/docs/command/atlas-api-streams-deleteStreamProcessor.txt +++ b/docs/command/atlas-api-streams-deleteStreamProcessor.txt @@ -12,10 +12,7 @@ atlas api streams deleteStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Delete a Stream Processor within the specified stream instance. - -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. +Delete a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt index 582daeac5e..fb0246c181 100644 --- a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt @@ -12,10 +12,7 @@ atlas api streams deleteVpcPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes an incoming VPC Peering connection. - -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. +Deletes an incoming VPC Peering connection. 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-deletevpcpeeringconnection. diff --git a/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt b/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt index 8b72350d1c..4243ae0783 100644 --- a/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt +++ b/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt @@ -12,10 +12,7 @@ atlas api streams downloadStreamTenantAuditLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Downloads the audit logs for the specified Atlas Streams Processing instance. - -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. +Downloads the audit logs for the specified Atlas Streams Processing instance. By default, logs cover periods of 30 days. To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". diff --git a/docs/command/atlas-api-streams-getAccountDetails.txt b/docs/command/atlas-api-streams-getAccountDetails.txt index d97b08149e..a9c21cea67 100644 --- a/docs/command/atlas-api-streams-getAccountDetails.txt +++ b/docs/command/atlas-api-streams-getAccountDetails.txt @@ -12,10 +12,7 @@ atlas api streams getAccountDetails :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the Account ID, and the VPC ID for the group and region specified. - -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. +Returns the Account ID, and the VPC ID for the group and region specified. 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-getaccountdetails. diff --git a/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt index f5949bac6d..410e6177c1 100644 --- a/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt +++ b/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt @@ -12,10 +12,7 @@ atlas api streams getActiveVpcPeeringConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns a list of active incoming VPC Peering Connections. - -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. +Returns a list of active incoming VPC Peering Connections. 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-getactivevpcpeeringconnections. diff --git a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt index 35dd098ca2..db2452b3ad 100644 --- a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt @@ -12,10 +12,7 @@ atlas api streams getPrivateLinkConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the details of one Private Link connection within the project. - -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. +Returns the details of one Private Link connection within the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-streams-getStreamConnection.txt b/docs/command/atlas-api-streams-getStreamConnection.txt index bd7eeb39c0..080db29980 100644 --- a/docs/command/atlas-api-streams-getStreamConnection.txt +++ b/docs/command/atlas-api-streams-getStreamConnection.txt @@ -12,10 +12,7 @@ atlas api streams getStreamConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the details of one stream connection within the specified stream instance. - -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. +Returns the details of one stream connection within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-streams-getStreamInstance.txt b/docs/command/atlas-api-streams-getStreamInstance.txt index fcd09fcbca..e2a5eb4d27 100644 --- a/docs/command/atlas-api-streams-getStreamInstance.txt +++ b/docs/command/atlas-api-streams-getStreamInstance.txt @@ -12,10 +12,7 @@ atlas api streams getStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the details of one stream instance within the specified project. - -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. +Returns the details of one stream instance within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-getStreamProcessor.txt b/docs/command/atlas-api-streams-getStreamProcessor.txt index b904ab586d..44145d14d5 100644 --- a/docs/command/atlas-api-streams-getStreamProcessor.txt +++ b/docs/command/atlas-api-streams-getStreamProcessor.txt @@ -12,10 +12,7 @@ atlas api streams getStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Get one Stream Processor within the specified stream instance. - -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. +Get one Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getVpcPeeringConnections.txt index 4fb9db7a37..a8e81c7e6a 100644 --- a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt +++ b/docs/command/atlas-api-streams-getVpcPeeringConnections.txt @@ -12,10 +12,7 @@ atlas api streams getVpcPeeringConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns a list of incoming VPC Peering Connections. - -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. +Returns a list of incoming VPC Peering Connections. 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-getvpcpeeringconnections. diff --git a/docs/command/atlas-api-streams-listPrivateLinkConnections.txt b/docs/command/atlas-api-streams-listPrivateLinkConnections.txt index 0710b5d669..b20e1c79f8 100644 --- a/docs/command/atlas-api-streams-listPrivateLinkConnections.txt +++ b/docs/command/atlas-api-streams-listPrivateLinkConnections.txt @@ -12,10 +12,7 @@ atlas api streams listPrivateLinkConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all Private Link connections for the specified project. - -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. +Returns all Private Link connections for the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-listStreamConnections.txt b/docs/command/atlas-api-streams-listStreamConnections.txt index 1ae2166a05..083a69fd8d 100644 --- a/docs/command/atlas-api-streams-listStreamConnections.txt +++ b/docs/command/atlas-api-streams-listStreamConnections.txt @@ -12,10 +12,7 @@ atlas api streams listStreamConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all connections of the stream instance for the specified project. - -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. +Returns all connections of the stream instance for the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-listStreamInstances.txt b/docs/command/atlas-api-streams-listStreamInstances.txt index 0a332a8461..6bd2b7ce8b 100644 --- a/docs/command/atlas-api-streams-listStreamInstances.txt +++ b/docs/command/atlas-api-streams-listStreamInstances.txt @@ -12,10 +12,7 @@ atlas api streams listStreamInstances :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all stream instances for the specified project. - -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. +Returns all stream instances for the specified project. 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-liststreaminstances. diff --git a/docs/command/atlas-api-streams-listStreamProcessors.txt b/docs/command/atlas-api-streams-listStreamProcessors.txt index d93d491baf..fd904c0fcc 100644 --- a/docs/command/atlas-api-streams-listStreamProcessors.txt +++ b/docs/command/atlas-api-streams-listStreamProcessors.txt @@ -12,10 +12,7 @@ atlas api streams listStreamProcessors :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all Stream Processors within the specified stream instance. - -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. +Returns all Stream Processors within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-modifyStreamProcessor.txt b/docs/command/atlas-api-streams-modifyStreamProcessor.txt index b027103910..d25c4ab355 100644 --- a/docs/command/atlas-api-streams-modifyStreamProcessor.txt +++ b/docs/command/atlas-api-streams-modifyStreamProcessor.txt @@ -12,10 +12,7 @@ atlas api streams modifyStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Modify one existing Stream Processor within the specified stream instance. - -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. +Modify one existing Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt index 37d3acb9b6..4d85b8ba37 100644 --- a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt @@ -12,10 +12,7 @@ atlas api streams rejectVpcPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Requests the rejection of an incoming VPC Peering connection. - -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. +Requests the rejection of an incoming VPC Peering connection. 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-rejectvpcpeeringconnection. diff --git a/docs/command/atlas-api-streams-startStreamProcessor.txt b/docs/command/atlas-api-streams-startStreamProcessor.txt index ceeb684aaf..218932e16b 100644 --- a/docs/command/atlas-api-streams-startStreamProcessor.txt +++ b/docs/command/atlas-api-streams-startStreamProcessor.txt @@ -12,10 +12,7 @@ atlas api streams startStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Start a Stream Processor within the specified stream instance. - -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. +Start a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-startStreamProcessorWith.txt b/docs/command/atlas-api-streams-startStreamProcessorWith.txt index 2ddc56bc6c..1fd321ce19 100644 --- a/docs/command/atlas-api-streams-startStreamProcessorWith.txt +++ b/docs/command/atlas-api-streams-startStreamProcessorWith.txt @@ -12,10 +12,7 @@ atlas api streams startStreamProcessorWith :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Start a Stream Processor within the specified stream instance. - -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. +Start a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-stopStreamProcessor.txt b/docs/command/atlas-api-streams-stopStreamProcessor.txt index 436b63a575..fba0a092a0 100644 --- a/docs/command/atlas-api-streams-stopStreamProcessor.txt +++ b/docs/command/atlas-api-streams-stopStreamProcessor.txt @@ -12,10 +12,7 @@ atlas api streams stopStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Stop a Stream Processor within the specified stream instance. - -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. +Stop a Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-updateStreamConnection.txt b/docs/command/atlas-api-streams-updateStreamConnection.txt index 6d7499e2e5..e628ecbb2a 100644 --- a/docs/command/atlas-api-streams-updateStreamConnection.txt +++ b/docs/command/atlas-api-streams-updateStreamConnection.txt @@ -12,10 +12,7 @@ atlas api streams updateStreamConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Update one connection for the specified stream instance in the specified project. - -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. +Update one connection for the specified stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-updateStreamInstance.txt b/docs/command/atlas-api-streams-updateStreamInstance.txt index 735582f880..eb696b2f74 100644 --- a/docs/command/atlas-api-streams-updateStreamInstance.txt +++ b/docs/command/atlas-api-streams-updateStreamInstance.txt @@ -12,10 +12,7 @@ atlas api streams updateStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Update one stream instance in the specified project. - -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. +Update one stream instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams.txt b/docs/command/atlas-api-streams.txt index 86d92c142e..aab49419fc 100644 --- a/docs/command/atlas-api-streams.txt +++ b/docs/command/atlas-api-streams.txt @@ -12,10 +12,7 @@ atlas api streams :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes Streams Instances. - -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. +Returns, adds, edits, and removes Streams Instances. This resource requires your project ID. @@ -54,36 +51,36 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-streams-acceptVpcPeeringConnection` - `Public Preview: please provide feedback `_: Requests the acceptance of an incoming VPC Peering connection. -* :ref:`atlas-api-streams-createPrivateLinkConnection` - `Public Preview: please provide feedback `_: Creates one Private Link in the specified project. -* :ref:`atlas-api-streams-createStreamConnection` - `Public Preview: please provide feedback `_: Creates one connection for a stream instance in the specified project. -* :ref:`atlas-api-streams-createStreamInstance` - `Public Preview: please provide feedback `_: Creates one stream instance in the specified project. -* :ref:`atlas-api-streams-createStreamInstanceWithSampleConnections` - `Public Preview: please provide feedback `_: Creates one stream instance in the specified project with sample connections. -* :ref:`atlas-api-streams-createStreamProcessor` - `Public Preview: please provide feedback `_: Create one Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-deletePrivateLinkConnection` - `Public Preview: please provide feedback `_: Deletes one Private Link in the specified project. -* :ref:`atlas-api-streams-deleteStreamConnection` - `Public Preview: please provide feedback `_: Delete one connection of the specified stream instance. -* :ref:`atlas-api-streams-deleteStreamInstance` - `Public Preview: please provide feedback `_: Delete one stream instance in the specified project. -* :ref:`atlas-api-streams-deleteStreamProcessor` - `Public Preview: please provide feedback `_: Delete a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-deleteVpcPeeringConnection` - `Public Preview: please provide feedback `_: Deletes an incoming VPC Peering connection. -* :ref:`atlas-api-streams-downloadStreamTenantAuditLogs` - `Public Preview: please provide feedback `_: Downloads the audit logs for the specified Atlas Streams Processing instance. -* :ref:`atlas-api-streams-getAccountDetails` - `Public Preview: please provide feedback `_: Returns the Account ID, and the VPC ID for the group and region specified. -* :ref:`atlas-api-streams-getActiveVpcPeeringConnections` - `Public Preview: please provide feedback `_: Returns a list of active incoming VPC Peering Connections. -* :ref:`atlas-api-streams-getPrivateLinkConnection` - `Public Preview: please provide feedback `_: Returns the details of one Private Link connection within the project. -* :ref:`atlas-api-streams-getStreamConnection` - `Public Preview: please provide feedback `_: Returns the details of one stream connection within the specified stream instance. -* :ref:`atlas-api-streams-getStreamInstance` - `Public Preview: please provide feedback `_: Returns the details of one stream instance within the specified project. -* :ref:`atlas-api-streams-getStreamProcessor` - `Public Preview: please provide feedback `_: Get one Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-getVpcPeeringConnections` - `Public Preview: please provide feedback `_: Returns a list of incoming VPC Peering Connections. -* :ref:`atlas-api-streams-listPrivateLinkConnections` - `Public Preview: please provide feedback `_: Returns all Private Link connections for the specified project. -* :ref:`atlas-api-streams-listStreamConnections` - `Public Preview: please provide feedback `_: Returns all connections of the stream instance for the specified project. -* :ref:`atlas-api-streams-listStreamInstances` - `Public Preview: please provide feedback `_: Returns all stream instances for the specified project. -* :ref:`atlas-api-streams-listStreamProcessors` - `Public Preview: please provide feedback `_: Returns all Stream Processors within the specified stream instance. -* :ref:`atlas-api-streams-modifyStreamProcessor` - `Public Preview: please provide feedback `_: Modify one existing Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-rejectVpcPeeringConnection` - `Public Preview: please provide feedback `_: Requests the rejection of an incoming VPC Peering connection. -* :ref:`atlas-api-streams-startStreamProcessor` - `Public Preview: please provide feedback `_: Start a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-startStreamProcessorWith` - `Public Preview: please provide feedback `_: Start a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-stopStreamProcessor` - `Public Preview: please provide feedback `_: Stop a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-updateStreamConnection` - `Public Preview: please provide feedback `_: Update one connection for the specified stream instance in the specified project. -* :ref:`atlas-api-streams-updateStreamInstance` - `Public Preview: please provide feedback `_: Update one stream instance in the specified project. +* :ref:`atlas-api-streams-acceptVpcPeeringConnection` - Requests the acceptance of an incoming VPC Peering connection. +* :ref:`atlas-api-streams-createPrivateLinkConnection` - Creates one Private Link in the specified project. +* :ref:`atlas-api-streams-createStreamConnection` - Creates one connection for a stream instance in the specified project. +* :ref:`atlas-api-streams-createStreamInstance` - Creates one stream instance in the specified project. +* :ref:`atlas-api-streams-createStreamInstanceWithSampleConnections` - Creates one stream instance in the specified project with sample connections. +* :ref:`atlas-api-streams-createStreamProcessor` - Create one Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-deletePrivateLinkConnection` - Deletes one Private Link in the specified project. +* :ref:`atlas-api-streams-deleteStreamConnection` - Delete one connection of the specified stream instance. +* :ref:`atlas-api-streams-deleteStreamInstance` - Delete one stream instance in the specified project. +* :ref:`atlas-api-streams-deleteStreamProcessor` - Delete a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-deleteVpcPeeringConnection` - Deletes an incoming VPC Peering connection. +* :ref:`atlas-api-streams-downloadStreamTenantAuditLogs` - Downloads the audit logs for the specified Atlas Streams Processing instance. +* :ref:`atlas-api-streams-getAccountDetails` - Returns the Account ID, and the VPC ID for the group and region specified. +* :ref:`atlas-api-streams-getActiveVpcPeeringConnections` - Returns a list of active incoming VPC Peering Connections. +* :ref:`atlas-api-streams-getPrivateLinkConnection` - Returns the details of one Private Link connection within the project. +* :ref:`atlas-api-streams-getStreamConnection` - Returns the details of one stream connection within the specified stream instance. +* :ref:`atlas-api-streams-getStreamInstance` - Returns the details of one stream instance within the specified project. +* :ref:`atlas-api-streams-getStreamProcessor` - Get one Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-getVpcPeeringConnections` - Returns a list of incoming VPC Peering Connections. +* :ref:`atlas-api-streams-listPrivateLinkConnections` - Returns all Private Link connections for the specified project. +* :ref:`atlas-api-streams-listStreamConnections` - Returns all connections of the stream instance for the specified project. +* :ref:`atlas-api-streams-listStreamInstances` - Returns all stream instances for the specified project. +* :ref:`atlas-api-streams-listStreamProcessors` - Returns all Stream Processors within the specified stream instance. +* :ref:`atlas-api-streams-modifyStreamProcessor` - Modify one existing Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-rejectVpcPeeringConnection` - Requests the rejection of an incoming VPC Peering connection. +* :ref:`atlas-api-streams-startStreamProcessor` - Start a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-startStreamProcessorWith` - Start a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-stopStreamProcessor` - Stop a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-updateStreamConnection` - Update one connection for the specified stream instance in the specified project. +* :ref:`atlas-api-streams-updateStreamInstance` - Update one stream instance in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-teams-addAllTeamsToProject.txt b/docs/command/atlas-api-teams-addAllTeamsToProject.txt index 90aa82355a..cddf5582b7 100644 --- a/docs/command/atlas-api-teams-addAllTeamsToProject.txt +++ b/docs/command/atlas-api-teams-addAllTeamsToProject.txt @@ -12,10 +12,7 @@ atlas api teams addAllTeamsToProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Adds one or more teams to the specified project. - -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. +Adds one or more teams to the specified project. All members of the team share the same project access. MongoDB Cloud limits the number of users to a maximum of 100 teams per project and a maximum of 250 teams per organization. To use this resource, the requesting API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-teams-addTeamUser.txt b/docs/command/atlas-api-teams-addTeamUser.txt index 6bcf2606d1..51bbf719f6 100644 --- a/docs/command/atlas-api-teams-addTeamUser.txt +++ b/docs/command/atlas-api-teams-addTeamUser.txt @@ -12,10 +12,7 @@ atlas api teams addTeamUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Adds one or more MongoDB Cloud users from the specified organization to the specified team. - -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. +Adds one or more MongoDB Cloud users from the specified organization to the specified team. Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-teams-createTeam.txt b/docs/command/atlas-api-teams-createTeam.txt index f1a472ad6d..80be91af11 100644 --- a/docs/command/atlas-api-teams-createTeam.txt +++ b/docs/command/atlas-api-teams-createTeam.txt @@ -12,10 +12,7 @@ atlas api teams createTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one team in the specified organization. - -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. +Creates one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits the number of teams to a maximum of 250 teams per organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-teams-deleteTeam.txt b/docs/command/atlas-api-teams-deleteTeam.txt index 258aba48bd..cb76bb1a41 100644 --- a/docs/command/atlas-api-teams-deleteTeam.txt +++ b/docs/command/atlas-api-teams-deleteTeam.txt @@ -12,10 +12,7 @@ atlas api teams deleteTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. - -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. +Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-teams-getProjectTeam.txt b/docs/command/atlas-api-teams-getProjectTeam.txt index a7d0e952d6..35619c66c3 100644 --- a/docs/command/atlas-api-teams-getProjectTeam.txt +++ b/docs/command/atlas-api-teams-getProjectTeam.txt @@ -12,10 +12,7 @@ atlas api teams getProjectTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one team to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. - -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. +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. diff --git a/docs/command/atlas-api-teams-getTeamById.txt b/docs/command/atlas-api-teams-getTeamById.txt index bf13569fee..7f0dcfd6d1 100644 --- a/docs/command/atlas-api-teams-getTeamById.txt +++ b/docs/command/atlas-api-teams-getTeamById.txt @@ -12,10 +12,7 @@ atlas api teams getTeamById :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one team that you identified using its unique 24-hexadecimal digit ID. - -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. +Returns one team that you identified using its unique 24-hexadecimal digit ID. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-teams-getTeamByName.txt b/docs/command/atlas-api-teams-getTeamByName.txt index 8ec4b30857..62167eb330 100644 --- a/docs/command/atlas-api-teams-getTeamByName.txt +++ b/docs/command/atlas-api-teams-getTeamByName.txt @@ -12,10 +12,7 @@ atlas api teams getTeamByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one team that you identified using its human-readable name. - -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. +Returns one team that you identified using its human-readable name. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-teams-listOrganizationTeams.txt b/docs/command/atlas-api-teams-listOrganizationTeams.txt index 93405a80d4..93abfabac2 100644 --- a/docs/command/atlas-api-teams-listOrganizationTeams.txt +++ b/docs/command/atlas-api-teams-listOrganizationTeams.txt @@ -12,10 +12,7 @@ atlas api teams listOrganizationTeams :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all teams that belong to the specified organization. - -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. +Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-teams-listProjectTeams.txt b/docs/command/atlas-api-teams-listProjectTeams.txt index 612203cb16..0b93fe4202 100644 --- a/docs/command/atlas-api-teams-listProjectTeams.txt +++ b/docs/command/atlas-api-teams-listProjectTeams.txt @@ -12,10 +12,7 @@ atlas api teams listProjectTeams :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. - -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. +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. diff --git a/docs/command/atlas-api-teams-removeProjectTeam.txt b/docs/command/atlas-api-teams-removeProjectTeam.txt index 052a7ffb46..80f326b417 100644 --- a/docs/command/atlas-api-teams-removeProjectTeam.txt +++ b/docs/command/atlas-api-teams-removeProjectTeam.txt @@ -12,10 +12,7 @@ atlas api teams removeProjectTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. - -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. +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. diff --git a/docs/command/atlas-api-teams-removeTeamUser.txt b/docs/command/atlas-api-teams-removeTeamUser.txt index f9cee4d3bb..41589e8457 100644 --- a/docs/command/atlas-api-teams-removeTeamUser.txt +++ b/docs/command/atlas-api-teams-removeTeamUser.txt @@ -12,10 +12,7 @@ atlas api teams removeTeamUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from the specified team. - -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. +Removes one MongoDB Cloud user from the specified team. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-teams-renameTeam.txt b/docs/command/atlas-api-teams-renameTeam.txt index c2a48f8b66..d574358b6c 100644 --- a/docs/command/atlas-api-teams-renameTeam.txt +++ b/docs/command/atlas-api-teams-renameTeam.txt @@ -12,10 +12,7 @@ atlas api teams renameTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Renames one team in the specified organization. - -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. +Renames one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-teams-updateTeamRoles.txt b/docs/command/atlas-api-teams-updateTeamRoles.txt index b1e50daced..ad2e4f02a7 100644 --- a/docs/command/atlas-api-teams-updateTeamRoles.txt +++ b/docs/command/atlas-api-teams-updateTeamRoles.txt @@ -12,10 +12,7 @@ atlas api teams updateTeamRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the project roles assigned to the specified team. - -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. +Updates the project roles assigned to the specified team. You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-teams.txt b/docs/command/atlas-api-teams.txt index fda64ae254..33798fd9e7 100644 --- a/docs/command/atlas-api-teams.txt +++ b/docs/command/atlas-api-teams.txt @@ -12,12 +12,7 @@ atlas api teams :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, or removes teams. - -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. - - +Returns, adds, edits, or removes teams. Options ------- @@ -54,19 +49,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-teams-addAllTeamsToProject` - `Public Preview: please provide feedback `_: Adds one or more teams to the specified project. -* :ref:`atlas-api-teams-addTeamUser` - `Public Preview: please provide feedback `_: Adds one or more MongoDB Cloud users from the specified organization to the specified team. -* :ref:`atlas-api-teams-createTeam` - `Public Preview: please provide feedback `_: Creates one team in the specified organization. -* :ref:`atlas-api-teams-deleteTeam` - `Public Preview: please provide feedback `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. -* :ref:`atlas-api-teams-getProjectTeam` - `Public Preview: please provide feedback `_: Returns one team to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. -* :ref:`atlas-api-teams-getTeamById` - `Public Preview: please provide feedback `_: Returns one team that you identified using its unique 24-hexadecimal digit ID. -* :ref:`atlas-api-teams-getTeamByName` - `Public Preview: please provide feedback `_: Returns one team that you identified using its human-readable name. -* :ref:`atlas-api-teams-listOrganizationTeams` - `Public Preview: please provide feedback `_: Returns all teams that belong to the specified organization. -* :ref:`atlas-api-teams-listProjectTeams` - `Public Preview: please provide feedback `_: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. -* :ref:`atlas-api-teams-removeProjectTeam` - `Public Preview: please provide feedback `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. -* :ref:`atlas-api-teams-removeTeamUser` - `Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from the specified team. -* :ref:`atlas-api-teams-renameTeam` - `Public Preview: please provide feedback `_: Renames one team in the specified organization. -* :ref:`atlas-api-teams-updateTeamRoles` - `Public Preview: please provide feedback `_: Updates the project roles assigned to the specified team. +* :ref:`atlas-api-teams-addAllTeamsToProject` - Adds one or more teams to the specified project. +* :ref:`atlas-api-teams-addTeamUser` - Adds one or more MongoDB Cloud users from the specified organization to the specified team. +* :ref:`atlas-api-teams-createTeam` - Creates one team in the specified organization. +* :ref:`atlas-api-teams-deleteTeam` - Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. +* :ref:`atlas-api-teams-getProjectTeam` - Returns one team to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. +* :ref:`atlas-api-teams-getTeamById` - Returns one team that you identified using its unique 24-hexadecimal digit ID. +* :ref:`atlas-api-teams-getTeamByName` - Returns one team that you identified using its human-readable name. +* :ref:`atlas-api-teams-listOrganizationTeams` - Returns all teams that belong to the specified organization. +* :ref:`atlas-api-teams-listProjectTeams` - Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. +* :ref:`atlas-api-teams-removeProjectTeam` - Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. +* :ref:`atlas-api-teams-removeTeamUser` - Removes one MongoDB Cloud user from the specified team. +* :ref:`atlas-api-teams-renameTeam` - Renames one team in the specified organization. +* :ref:`atlas-api-teams-updateTeamRoles` - Updates the project roles assigned to the specified team. .. toctree:: diff --git a/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt index b0bdfe85ff..5d2a05b746 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt @@ -12,10 +12,7 @@ atlas api thirdPartyIntegrations createThirdPartyIntegration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Adds the settings for configuring one third-party service integration. - -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. +Adds the settings for configuring one third-party service integration. These settings apply to all databases managed in the specified MongoDB Cloud project. Each project can have only one configuration per {INTEGRATION-TYPE}. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt index dd2928cbe9..69b3c10a91 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt @@ -12,10 +12,7 @@ atlas api thirdPartyIntegrations deleteThirdPartyIntegration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes the settings that permit configuring one third-party service integration. - -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. +Removes the settings that permit configuring one third-party service integration. These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured {INTEGRATION-TYPE} integrations. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt index 886ece2689..0329ffd94f 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt @@ -12,10 +12,7 @@ atlas api thirdPartyIntegrations getThirdPartyIntegration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the settings for configuring integration with one third-party service. - -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. +Returns the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt index 36a8ae815b..29fad23bd6 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt @@ -12,10 +12,7 @@ atlas api thirdPartyIntegrations listThirdPartyIntegrations :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the settings that permit integrations with all configured third-party services. - -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. +Returns the settings that permit integrations with all configured third-party services. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt index 7f38b63612..92bb8e453e 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt @@ -12,10 +12,7 @@ atlas api thirdPartyIntegrations updateThirdPartyIntegration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the settings for configuring integration with one third-party service. - -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. +Updates the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. diff --git a/docs/command/atlas-api-thirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations.txt index d2971d8f61..af79740965 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations.txt @@ -12,10 +12,7 @@ atlas api thirdPartyIntegrations :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes third-party service integration configurations. - -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. +Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure. @@ -57,11 +54,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-thirdPartyIntegrations-createThirdPartyIntegration` - `Public Preview: please provide feedback `_: Adds the settings for configuring one third-party service integration. -* :ref:`atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration` - `Public Preview: please provide feedback `_: Removes the settings that permit configuring one third-party service integration. -* :ref:`atlas-api-thirdPartyIntegrations-getThirdPartyIntegration` - `Public Preview: please provide feedback `_: Returns the settings for configuring integration with one third-party service. -* :ref:`atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations` - `Public Preview: please provide feedback `_: Returns the settings that permit integrations with all configured third-party services. -* :ref:`atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration` - `Public Preview: please provide feedback `_: Updates the settings for configuring integration with one third-party service. +* :ref:`atlas-api-thirdPartyIntegrations-createThirdPartyIntegration` - Adds the settings for configuring one third-party service integration. +* :ref:`atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration` - Removes the settings that permit configuring one third-party service integration. +* :ref:`atlas-api-thirdPartyIntegrations-getThirdPartyIntegration` - Returns the settings for configuring integration with one third-party service. +* :ref:`atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations` - Returns the settings that permit integrations with all configured third-party services. +* :ref:`atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration` - Updates the settings for configuring integration with one third-party service. .. toctree:: diff --git a/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt b/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt index ad9516b8a6..6a89fd6729 100644 --- a/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt +++ b/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt @@ -12,10 +12,7 @@ atlas api x509Authentication createDatabaseUserCertificate :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Generates one X.509 certificate for the specified MongoDB user. - -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. +Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt b/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt index bb5656a513..aa8b3d3e15 100644 --- a/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt +++ b/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt @@ -12,10 +12,7 @@ atlas api x509Authentication disableCustomerManagedX509 :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. - -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. +Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint. diff --git a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt b/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt index 8450c3c373..992049864d 100644 --- a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt +++ b/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt @@ -12,10 +12,7 @@ atlas api x509Authentication listDatabaseUserCertificates :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all unexpired X.509 certificates for the specified MongoDB user. - -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. +Returns all unexpired X.509 certificates for the specified MongoDB user. This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-x509Authentication.txt b/docs/command/atlas-api-x509Authentication.txt index a18b96f914..4ca597d0be 100644 --- a/docs/command/atlas-api-x509Authentication.txt +++ b/docs/command/atlas-api-x509Authentication.txt @@ -12,10 +12,7 @@ atlas api x509Authentication :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, edits, and removes user-managed X.509 configurations. - -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. +Returns, edits, and removes user-managed X.509 configurations. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users. @@ -54,9 +51,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-x509Authentication-createDatabaseUserCertificate` - `Public Preview: please provide feedback `_: Generates one X.509 certificate for the specified MongoDB user. -* :ref:`atlas-api-x509Authentication-disableCustomerManagedX509` - `Public Preview: please provide feedback `_: Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. -* :ref:`atlas-api-x509Authentication-listDatabaseUserCertificates` - `Public Preview: please provide feedback `_: Returns all unexpired X.509 certificates for the specified MongoDB user. +* :ref:`atlas-api-x509Authentication-createDatabaseUserCertificate` - Generates one X.509 certificate for the specified MongoDB user. +* :ref:`atlas-api-x509Authentication-disableCustomerManagedX509` - Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. +* :ref:`atlas-api-x509Authentication-listDatabaseUserCertificates` - Returns all unexpired X.509 certificates for the specified MongoDB user. .. toctree:: diff --git a/docs/command/atlas-api.txt b/docs/command/atlas-api.txt index 61f0485342..a351a05656 100644 --- a/docs/command/atlas-api.txt +++ b/docs/command/atlas-api.txt @@ -12,17 +12,14 @@ atlas api :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '. +Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '. -This feature in public preview streamlines script development by letting you interact directly with any Atlas Administration API endpoint by using the Atlas CLI. +This feature streamlines script development by letting you interact directly with any Atlas Administration API endpoint by using the Atlas CLI. For more information on - Atlas Administration API see: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/ - Getting started with the Atlas Administration API: https://www.mongodb.com/docs/atlas/configure-api-access/#std-label-atlas-admin-api-access -Public Preview: 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. - Syntax ------ @@ -174,56 +171,56 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-accessTracking` - `Public Preview: please provide feedback `_: Returns access logs for authentication attempts made to Atlas database deployments. -* :ref:`atlas-api-alertConfigurations` - `Public Preview: please provide feedback `_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. -* :ref:`atlas-api-alerts` - `Public Preview: please provide feedback `_: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. -* :ref:`atlas-api-atlasSearch` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. -* :ref:`atlas-api-auditing` - `Public Preview: please provide feedback `_: Returns and edits database auditing settings for MongoDB Cloud projects. -* :ref:`atlas-api-awsClustersDns` - `Public Preview: please provide feedback `_: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. -* :ref:`atlas-api-cloudBackups` - `Public Preview: please provide feedback `_: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. -* :ref:`atlas-api-cloudMigrationService` - `Public Preview: please provide feedback `_: Manages the Cloud Migration Service. -* :ref:`atlas-api-cloudProviderAccess` - `Public Preview: please provide feedback `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. -* :ref:`atlas-api-clusterOutageSimulation` - `Public Preview: please provide feedback `_: Returns, starts, or ends a cluster outage simulation. -* :ref:`atlas-api-clusters` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes database deployments. -* :ref:`atlas-api-collectionLevelMetrics` - `Public Preview: please provide feedback `_: Returns, adds, and edits pinned namespaces for the specified cluster or process. -* :ref:`atlas-api-customDatabaseRoles` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes custom database user privilege roles. -* :ref:`atlas-api-dataFederation` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes Federated Database Instances. -* :ref:`atlas-api-databaseUsers` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes database users. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement` - `Public Preview: please provide feedback `_: Returns and edits the Encryption at Rest using Customer Key Management configuration. -* :ref:`atlas-api-events` - `Public Preview: please provide feedback `_: Returns events. -* :ref:`atlas-api-federatedAuthentication` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. -* :ref:`atlas-api-flexClusters` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes flex clusters. -* :ref:`atlas-api-flexRestoreJobs` - `Public Preview: please provide feedback `_: Returns and adds restore jobs for flex database deployments. -* :ref:`atlas-api-flexSnapshots` - `Public Preview: please provide feedback `_: Returns and requests to download flex database deployment snapshots. -* :ref:`atlas-api-globalClusters` - `Public Preview: please provide feedback `_: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. -* :ref:`atlas-api-invoices` - `Public Preview: please provide feedback `_: Returns invoices. -* :ref:`atlas-api-ldapConfiguration` - `Public Preview: please provide feedback `_: Returns, edits, verifies, and removes LDAP configurations. -* :ref:`atlas-api-legacyBackup` - `Public Preview: please provide feedback `_: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. -* :ref:`atlas-api-maintenanceWindows` - `Public Preview: please provide feedback `_: Returns, edits, and removes maintenance windows. -* :ref:`atlas-api-mongoDbCloudUsers` - `Public Preview: please provide feedback `_: Returns, adds, and edits MongoDB Cloud users. -* :ref:`atlas-api-monitoringAndLogs` - `Public Preview: please provide feedback `_: Returns database deployment monitoring and logging data. -* :ref:`atlas-api-networkPeering` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes network peering containers and peering connections. -* :ref:`atlas-api-onlineArchive` - `Public Preview: please provide feedback `_: Returns, adds, edits, or removes an online archive. -* :ref:`atlas-api-organizations` - `Public Preview: please provide feedback `_: Returns, adds, and edits organizational units in MongoDB Cloud. -* :ref:`atlas-api-performanceAdvisor` - `Public Preview: please provide feedback `_: Returns suggested indexes and slow query data for a database deployment. -* :ref:`atlas-api-privateEndpointServices` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes private endpoint services. -* :ref:`atlas-api-programmaticApiKeys` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. -* :ref:`atlas-api-projectIpAccessList` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes network access limits to database deployments in Atlas. -* :ref:`atlas-api-projects` - `Public Preview: please provide feedback `_: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. -* :ref:`atlas-api-pushBasedLogExport` - `Public Preview: please provide feedback `_: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. -* :ref:`atlas-api-queryShapeInsights` - `Public Preview: please provide feedback `_: -* :ref:`atlas-api-resourcePolicies` - `Public Preview: please provide feedback `_: Configure and manage Atlas Resource Policies within your organization. -* :ref:`atlas-api-rollingIndex` - `Public Preview: please provide feedback `_: Creates one index to a database deployment in a rolling manner. -* :ref:`atlas-api-root` - `Public Preview: please provide feedback `_: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. -* :ref:`atlas-api-serverlessInstances` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes serverless instances. -* :ref:`atlas-api-serverlessPrivateEndpoints` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes private endpoints for serverless instances. -* :ref:`atlas-api-serviceAccounts` - `Public Preview: please provide feedback `_: Endpoints for managing Service Accounts and secrets. -* :ref:`atlas-api-sharedTierRestoreJobs` - `Public Preview: please provide feedback `_: Returns and adds restore jobs for shared-tier database deployments. -* :ref:`atlas-api-sharedTierSnapshots` - `Public Preview: please provide feedback `_: Returns and requests to download shared-tier database deployment snapshots. -* :ref:`atlas-api-streams` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes Streams Instances. -* :ref:`atlas-api-teams` - `Public Preview: please provide feedback `_: Returns, adds, edits, or removes teams. -* :ref:`atlas-api-thirdPartyIntegrations` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes third-party service integration configurations. -* :ref:`atlas-api-x509Authentication` - `Public Preview: please provide feedback `_: Returns, edits, and removes user-managed X.509 configurations. +* :ref:`atlas-api-accessTracking` - Returns access logs for authentication attempts made to Atlas database deployments. +* :ref:`atlas-api-alertConfigurations` - Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. +* :ref:`atlas-api-alerts` - Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. +* :ref:`atlas-api-atlasSearch` - Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. +* :ref:`atlas-api-auditing` - Returns and edits database auditing settings for MongoDB Cloud projects. +* :ref:`atlas-api-awsClustersDns` - Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. +* :ref:`atlas-api-cloudBackups` - Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. +* :ref:`atlas-api-cloudMigrationService` - Manages the Cloud Migration Service. +* :ref:`atlas-api-cloudProviderAccess` - Returns, adds, authorizes, and removes AWS IAM roles in Atlas. +* :ref:`atlas-api-clusterOutageSimulation` - Returns, starts, or ends a cluster outage simulation. +* :ref:`atlas-api-clusters` - Returns, adds, edits, and removes database deployments. +* :ref:`atlas-api-collectionLevelMetrics` - Returns, adds, and edits pinned namespaces for the specified cluster or process. +* :ref:`atlas-api-customDatabaseRoles` - Returns, adds, edits, and removes custom database user privilege roles. +* :ref:`atlas-api-dataFederation` - Returns, adds, edits, and removes Federated Database Instances. +* :ref:`atlas-api-databaseUsers` - Returns, adds, edits, and removes database users. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement` - Returns and edits the Encryption at Rest using Customer Key Management configuration. +* :ref:`atlas-api-events` - Returns events. +* :ref:`atlas-api-federatedAuthentication` - Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. +* :ref:`atlas-api-flexClusters` - Returns, adds, edits, and removes flex clusters. +* :ref:`atlas-api-flexRestoreJobs` - Returns and adds restore jobs for flex database deployments. +* :ref:`atlas-api-flexSnapshots` - Returns and requests to download flex database deployment snapshots. +* :ref:`atlas-api-globalClusters` - Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. +* :ref:`atlas-api-invoices` - Returns invoices. +* :ref:`atlas-api-ldapConfiguration` - Returns, edits, verifies, and removes LDAP configurations. +* :ref:`atlas-api-legacyBackup` - Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. +* :ref:`atlas-api-maintenanceWindows` - Returns, edits, and removes maintenance windows. +* :ref:`atlas-api-mongoDbCloudUsers` - Returns, adds, and edits MongoDB Cloud users. +* :ref:`atlas-api-monitoringAndLogs` - Returns database deployment monitoring and logging data. +* :ref:`atlas-api-networkPeering` - Returns, adds, edits, and removes network peering containers and peering connections. +* :ref:`atlas-api-onlineArchive` - Returns, adds, edits, or removes an online archive. +* :ref:`atlas-api-organizations` - Returns, adds, and edits organizational units in MongoDB Cloud. +* :ref:`atlas-api-performanceAdvisor` - Returns suggested indexes and slow query data for a database deployment. +* :ref:`atlas-api-privateEndpointServices` - Returns, adds, edits, and removes private endpoint services. +* :ref:`atlas-api-programmaticApiKeys` - Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. +* :ref:`atlas-api-projectIpAccessList` - Returns, adds, edits, and removes network access limits to database deployments in Atlas. +* :ref:`atlas-api-projects` - Returns, adds, and edits collections of clusters and users in MongoDB Cloud. +* :ref:`atlas-api-pushBasedLogExport` - You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. +* :ref:`atlas-api-queryShapeInsights` - +* :ref:`atlas-api-resourcePolicies` - Configure and manage Atlas Resource Policies within your organization. +* :ref:`atlas-api-rollingIndex` - Creates one index to a database deployment in a rolling manner. +* :ref:`atlas-api-root` - Returns details that describe the MongoDB Cloud build and the access token that requests this resource. +* :ref:`atlas-api-serverlessInstances` - Returns, adds, edits, and removes serverless instances. +* :ref:`atlas-api-serverlessPrivateEndpoints` - Returns, adds, edits, and removes private endpoints for serverless instances. +* :ref:`atlas-api-serviceAccounts` - Endpoints for managing Service Accounts and secrets. +* :ref:`atlas-api-sharedTierRestoreJobs` - Returns and adds restore jobs for shared-tier database deployments. +* :ref:`atlas-api-sharedTierSnapshots` - Returns and requests to download shared-tier database deployment snapshots. +* :ref:`atlas-api-streams` - Returns, adds, edits, and removes Streams Instances. +* :ref:`atlas-api-teams` - Returns, adds, edits, or removes teams. +* :ref:`atlas-api-thirdPartyIntegrations` - Returns, adds, edits, and removes third-party service integration configurations. +* :ref:`atlas-api-x509Authentication` - Returns, edits, and removes user-managed X.509 configurations. .. toctree:: diff --git a/docs/command/atlas.txt b/docs/command/atlas.txt index 81cb3827b9..fa500acb46 100644 --- a/docs/command/atlas.txt +++ b/docs/command/atlas.txt @@ -53,7 +53,7 @@ Related Commands * :ref:`atlas-accessLists` - Manage the list of IP addresses that can access your Atlas project. * :ref:`atlas-accessLogs` - Return the access logs for a cluster. * :ref:`atlas-alerts` - Manage alerts for your project. -* :ref:`atlas-api` - `Public Preview: please provide feedback `_: Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '. +* :ref:`atlas-api` - Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '. * :ref:`atlas-auditing` - Returns database auditing settings for MongoDB Cloud projects. * :ref:`atlas-auth` - Manage the CLI's authentication state. * :ref:`atlas-backups` - Manage cloud backups for your project. From c8b2513a3cc3f83b995ce9c5d866e3f49e61bbfe Mon Sep 17 00:00:00 2001 From: Luke Sanderson Date: Thu, 25 Sep 2025 15:55:25 +0100 Subject: [PATCH 04/11] golint space --- internal/cli/help_templates.go | 1 - 1 file changed, 1 deletion(-) diff --git a/internal/cli/help_templates.go b/internal/cli/help_templates.go index daaf8a70c3..8fe7840dc9 100644 --- a/internal/cli/help_templates.go +++ b/internal/cli/help_templates.go @@ -20,5 +20,4 @@ const ( HelpTemplate = `{{.Short | trimTrailingWhitespaces}} {{.Long | trimTrailingWhitespaces}} {{if or .Runnable .HasSubCommands}}{{.UsageString}}{{end}}` - ) From 73a380e8da3dd30c3f67e5d105a244b37b466d79 Mon Sep 17 00:00:00 2001 From: Luke Sanderson Date: Thu, 25 Sep 2025 18:00:01 +0100 Subject: [PATCH 05/11] Re-add api help docs template --- internal/cli/api/api.go | 2 +- internal/cli/help_templates.go | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/internal/cli/api/api.go b/internal/cli/api/api.go index b46772c497..68d13c5a72 100644 --- a/internal/cli/api/api.go +++ b/internal/cli/api/api.go @@ -79,7 +79,7 @@ For more information on - Getting started with the Atlas Administration API: https://www.mongodb.com/docs/atlas/configure-api-access/#std-label-atlas-admin-api-access`, } - rootCmd.SetHelpTemplate(cli.HelpTemplate) + rootCmd.SetHelpTemplate(cli.APICommandHelpTemplate) return rootCmd } diff --git a/internal/cli/help_templates.go b/internal/cli/help_templates.go index 8fe7840dc9..37aa8ec2eb 100644 --- a/internal/cli/help_templates.go +++ b/internal/cli/help_templates.go @@ -20,4 +20,11 @@ const ( HelpTemplate = `{{.Short | trimTrailingWhitespaces}} {{.Long | trimTrailingWhitespaces}} {{if or .Runnable .HasSubCommands}}{{.UsageString}}{{end}}` + + ExperimentalText = "The atlas api sub-command, " + + "automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.\n" + + "Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint " + + "documentation link.\n\n" + + APICommandHelpTemplate = ExperimentalText + HelpTemplate ) From 53b81e63210985d17080fb3bc672c91bfd7faba9 Mon Sep 17 00:00:00 2001 From: Luke Sanderson Date: Fri, 26 Sep 2025 11:27:01 +0100 Subject: [PATCH 06/11] Variable Rename and re-add long-text api autogeneration disclaimer --- docs/command/atlas-api.txt | 3 +++ internal/cli/help_templates.go | 4 ++-- tools/cmd/docs/api_docs_long_text.txt | 3 +++ 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/command/atlas-api.txt b/docs/command/atlas-api.txt index a351a05656..64ae77360f 100644 --- a/docs/command/atlas-api.txt +++ b/docs/command/atlas-api.txt @@ -20,6 +20,9 @@ For more information on - Atlas Administration API see: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/ - Getting started with the Atlas Administration API: https://www.mongodb.com/docs/atlas/configure-api-access/#std-label-atlas-admin-api-access +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Syntax ------ diff --git a/internal/cli/help_templates.go b/internal/cli/help_templates.go index 37aa8ec2eb..cca770f3cd 100644 --- a/internal/cli/help_templates.go +++ b/internal/cli/help_templates.go @@ -21,10 +21,10 @@ const ( {{if or .Runnable .HasSubCommands}}{{.UsageString}}{{end}}` - ExperimentalText = "The atlas api sub-command, " + + APICommandText = "The atlas api sub-command, " + "automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.\n" + "Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint " + "documentation link.\n\n" - APICommandHelpTemplate = ExperimentalText + HelpTemplate + APICommandHelpTemplate = APICommandText + HelpTemplate ) diff --git a/tools/cmd/docs/api_docs_long_text.txt b/tools/cmd/docs/api_docs_long_text.txt index f99762128f..4e87233b66 100644 --- a/tools/cmd/docs/api_docs_long_text.txt +++ b/tools/cmd/docs/api_docs_long_text.txt @@ -1,3 +1,6 @@ +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Syntax ------ From 9c6099ba21000e61b197a698322b89156c4cbfaf Mon Sep 17 00:00:00 2001 From: Luke Sanderson Date: Fri, 26 Sep 2025 11:35:58 +0100 Subject: [PATCH 07/11] run make gen-docs --- ...as-api-accessTracking-listAccessLogsByClusterName.txt | 3 +++ ...atlas-api-accessTracking-listAccessLogsByHostname.txt | 3 +++ docs/command/atlas-api-accessTracking.txt | 3 +++ ...-api-alertConfigurations-createAlertConfiguration.txt | 3 +++ ...-api-alertConfigurations-deleteAlertConfiguration.txt | 3 +++ ...las-api-alertConfigurations-getAlertConfiguration.txt | 3 +++ ...urations-listAlertConfigurationMatchersFieldNames.txt | 3 +++ ...s-api-alertConfigurations-listAlertConfigurations.txt | 3 +++ ...rtConfigurations-listAlertConfigurationsByAlertId.txt | 3 +++ ...-api-alertConfigurations-toggleAlertConfiguration.txt | 3 +++ ...-api-alertConfigurations-updateAlertConfiguration.txt | 3 +++ docs/command/atlas-api-alertConfigurations.txt | 3 +++ docs/command/atlas-api-alerts-acknowledgeAlert.txt | 3 +++ docs/command/atlas-api-alerts-getAlert.txt | 3 +++ docs/command/atlas-api-alerts-listAlerts.txt | 3 +++ ...atlas-api-alerts-listAlertsByAlertConfigurationId.txt | 3 +++ docs/command/atlas-api-alerts.txt | 3 +++ ...atlas-api-atlasSearch-createAtlasSearchDeployment.txt | 3 +++ .../atlas-api-atlasSearch-createAtlasSearchIndex.txt | 3 +++ ...-api-atlasSearch-createAtlasSearchIndexDeprecated.txt | 3 +++ ...atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt | 3 +++ .../atlas-api-atlasSearch-deleteAtlasSearchIndex.txt | 3 +++ ...tlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt | 3 +++ ...-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt | 3 +++ .../atlas-api-atlasSearch-getAtlasSearchDeployment.txt | 3 +++ .../atlas-api-atlasSearch-getAtlasSearchIndex.txt | 3 +++ .../atlas-api-atlasSearch-getAtlasSearchIndexByName.txt | 3 +++ ...las-api-atlasSearch-getAtlasSearchIndexDeprecated.txt | 3 +++ .../atlas-api-atlasSearch-listAtlasSearchIndexes.txt | 3 +++ ...las-api-atlasSearch-listAtlasSearchIndexesCluster.txt | 3 +++ ...-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt | 3 +++ ...atlas-api-atlasSearch-updateAtlasSearchDeployment.txt | 3 +++ .../atlas-api-atlasSearch-updateAtlasSearchIndex.txt | 3 +++ ...tlas-api-atlasSearch-updateAtlasSearchIndexByName.txt | 3 +++ ...-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt | 3 +++ docs/command/atlas-api-atlasSearch.txt | 3 +++ .../atlas-api-auditing-getAuditingConfiguration.txt | 3 +++ .../atlas-api-auditing-updateAuditingConfiguration.txt | 3 +++ docs/command/atlas-api-auditing.txt | 5 +++++ .../command/atlas-api-awsClustersDns-getAwsCustomDns.txt | 3 +++ .../atlas-api-awsClustersDns-toggleAwsCustomDns.txt | 3 +++ docs/command/atlas-api-awsClustersDns.txt | 3 +++ .../atlas-api-cloudBackups-cancelBackupRestoreJob.txt | 3 +++ .../atlas-api-cloudBackups-createBackupExportJob.txt | 3 +++ .../atlas-api-cloudBackups-createBackupRestoreJob.txt | 3 +++ .../atlas-api-cloudBackups-createExportBucket.txt | 3 +++ ...api-cloudBackups-createServerlessBackupRestoreJob.txt | 3 +++ .../atlas-api-cloudBackups-deleteAllBackupSchedules.txt | 3 +++ .../atlas-api-cloudBackups-deleteExportBucket.txt | 3 +++ .../atlas-api-cloudBackups-deleteReplicaSetBackup.txt | 3 +++ ...atlas-api-cloudBackups-deleteShardedClusterBackup.txt | 3 +++ ...as-api-cloudBackups-disableDataProtectionSettings.txt | 3 +++ .../atlas-api-cloudBackups-getBackupExportJob.txt | 3 +++ .../atlas-api-cloudBackups-getBackupRestoreJob.txt | 3 +++ .../command/atlas-api-cloudBackups-getBackupSchedule.txt | 3 +++ .../atlas-api-cloudBackups-getDataProtectionSettings.txt | 3 +++ docs/command/atlas-api-cloudBackups-getExportBucket.txt | 3 +++ .../atlas-api-cloudBackups-getReplicaSetBackup.txt | 3 +++ .../atlas-api-cloudBackups-getServerlessBackup.txt | 3 +++ ...as-api-cloudBackups-getServerlessBackupRestoreJob.txt | 3 +++ .../atlas-api-cloudBackups-getShardedClusterBackup.txt | 3 +++ .../atlas-api-cloudBackups-listBackupExportJobs.txt | 3 +++ .../atlas-api-cloudBackups-listBackupRestoreJobs.txt | 3 +++ .../command/atlas-api-cloudBackups-listExportBuckets.txt | 3 +++ .../atlas-api-cloudBackups-listReplicaSetBackups.txt | 3 +++ ...-api-cloudBackups-listServerlessBackupRestoreJobs.txt | 3 +++ .../atlas-api-cloudBackups-listServerlessBackups.txt | 3 +++ .../atlas-api-cloudBackups-listShardedClusterBackups.txt | 3 +++ docs/command/atlas-api-cloudBackups-takeSnapshot.txt | 3 +++ .../atlas-api-cloudBackups-updateBackupSchedule.txt | 3 +++ ...las-api-cloudBackups-updateDataProtectionSettings.txt | 3 +++ .../atlas-api-cloudBackups-updateSnapshotRetention.txt | 3 +++ docs/command/atlas-api-cloudBackups.txt | 3 +++ .../atlas-api-cloudMigrationService-createLinkToken.txt | 3 +++ ...las-api-cloudMigrationService-createPushMigration.txt | 3 +++ .../atlas-api-cloudMigrationService-cutoverMigration.txt | 3 +++ .../atlas-api-cloudMigrationService-deleteLinkToken.txt | 3 +++ .../atlas-api-cloudMigrationService-getPushMigration.txt | 3 +++ ...las-api-cloudMigrationService-getValidationStatus.txt | 3 +++ ...tlas-api-cloudMigrationService-listSourceProjects.txt | 3 +++ ...atlas-api-cloudMigrationService-validateMigration.txt | 3 +++ docs/command/atlas-api-cloudMigrationService.txt | 3 +++ ...udProviderAccess-authorizeCloudProviderAccessRole.txt | 3 +++ ...cloudProviderAccess-createCloudProviderAccessRole.txt | 3 +++ ...ProviderAccess-deauthorizeCloudProviderAccessRole.txt | 3 +++ ...pi-cloudProviderAccess-getCloudProviderAccessRole.txt | 3 +++ ...-cloudProviderAccess-listCloudProviderAccessRoles.txt | 3 +++ docs/command/atlas-api-cloudProviderAccess.txt | 5 +++++ ...s-api-clusterOutageSimulation-endOutageSimulation.txt | 3 +++ ...s-api-clusterOutageSimulation-getOutageSimulation.txt | 3 +++ ...api-clusterOutageSimulation-startOutageSimulation.txt | 3 +++ docs/command/atlas-api-clusterOutageSimulation.txt | 5 +++++ .../atlas-api-clusters-autoScalingConfiguration.txt | 3 +++ docs/command/atlas-api-clusters-createCluster.txt | 3 +++ docs/command/atlas-api-clusters-deleteCluster.txt | 3 +++ docs/command/atlas-api-clusters-getCluster.txt | 3 +++ ...tlas-api-clusters-getClusterAdvancedConfiguration.txt | 3 +++ docs/command/atlas-api-clusters-getClusterStatus.txt | 3 +++ .../atlas-api-clusters-getSampleDatasetLoadStatus.txt | 3 +++ .../atlas-api-clusters-grantMongoDbEmployeeAccess.txt | 3 +++ .../atlas-api-clusters-listCloudProviderRegions.txt | 3 +++ docs/command/atlas-api-clusters-listClusters.txt | 3 +++ .../atlas-api-clusters-listClustersForAllProjects.txt | 3 +++ docs/command/atlas-api-clusters-loadSampleDataset.txt | 3 +++ ...atlas-api-clusters-pinFeatureCompatibilityVersion.txt | 3 +++ .../atlas-api-clusters-revokeMongoDbEmployeeAccess.txt | 3 +++ docs/command/atlas-api-clusters-testFailover.txt | 3 +++ ...las-api-clusters-unpinFeatureCompatibilityVersion.txt | 3 +++ docs/command/atlas-api-clusters-updateCluster.txt | 3 +++ ...s-api-clusters-updateClusterAdvancedConfiguration.txt | 3 +++ docs/command/atlas-api-clusters-upgradeSharedCluster.txt | 3 +++ docs/command/atlas-api-clusters.txt | 3 +++ ...s-getCollStatsLatencyNamespaceClusterMeasurements.txt | 3 +++ ...rics-getCollStatsLatencyNamespaceHostMeasurements.txt | 3 +++ ...nLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt | 3 +++ ...elMetrics-getCollStatsLatencyNamespacesForCluster.txt | 3 +++ ...LevelMetrics-getCollStatsLatencyNamespacesForHost.txt | 3 +++ ...as-api-collectionLevelMetrics-getPinnedNamespaces.txt | 3 +++ ...las-api-collectionLevelMetrics-pinNamespacesPatch.txt | 3 +++ ...atlas-api-collectionLevelMetrics-pinNamespacesPut.txt | 3 +++ .../atlas-api-collectionLevelMetrics-unpinNamespaces.txt | 3 +++ docs/command/atlas-api-collectionLevelMetrics.txt | 3 +++ ...-api-customDatabaseRoles-createCustomDatabaseRole.txt | 3 +++ ...-api-customDatabaseRoles-deleteCustomDatabaseRole.txt | 3 +++ ...las-api-customDatabaseRoles-getCustomDatabaseRole.txt | 3 +++ ...s-api-customDatabaseRoles-listCustomDatabaseRoles.txt | 3 +++ ...-api-customDatabaseRoles-updateCustomDatabaseRole.txt | 3 +++ docs/command/atlas-api-customDatabaseRoles.txt | 3 +++ ...ataFederation-createDataFederationPrivateEndpoint.txt | 3 +++ .../atlas-api-dataFederation-createFederatedDatabase.txt | 3 +++ ...-dataFederation-createOneDataFederationQueryLimit.txt | 3 +++ ...ataFederation-deleteDataFederationPrivateEndpoint.txt | 3 +++ .../atlas-api-dataFederation-deleteFederatedDatabase.txt | 3 +++ ...eration-deleteOneDataFederationInstanceQueryLimit.txt | 3 +++ ...dataFederation-downloadFederatedDatabaseQueryLogs.txt | 3 +++ ...i-dataFederation-getDataFederationPrivateEndpoint.txt | 3 +++ .../atlas-api-dataFederation-getFederatedDatabase.txt | 3 +++ ...dataFederation-listDataFederationPrivateEndpoints.txt | 3 +++ .../atlas-api-dataFederation-listFederatedDatabases.txt | 3 +++ ...-dataFederation-returnFederatedDatabaseQueryLimit.txt | 3 +++ ...dataFederation-returnFederatedDatabaseQueryLimits.txt | 3 +++ .../atlas-api-dataFederation-updateFederatedDatabase.txt | 3 +++ docs/command/atlas-api-dataFederation.txt | 3 +++ .../atlas-api-databaseUsers-createDatabaseUser.txt | 3 +++ .../atlas-api-databaseUsers-deleteDatabaseUser.txt | 3 +++ docs/command/atlas-api-databaseUsers-getDatabaseUser.txt | 3 +++ .../atlas-api-databaseUsers-listDatabaseUsers.txt | 3 +++ .../atlas-api-databaseUsers-updateDatabaseUser.txt | 3 +++ docs/command/atlas-api-databaseUsers.txt | 5 +++++ ...yManagement-createEncryptionAtRestPrivateEndpoint.txt | 3 +++ ...estUsingCustomerKeyManagement-getEncryptionAtRest.txt | 3 +++ ...rKeyManagement-getEncryptionAtRestPrivateEndpoint.txt | 3 +++ ...tEncryptionAtRestPrivateEndpointsForCloudProvider.txt | 3 +++ ...nt-requestEncryptionAtRestPrivateEndpointDeletion.txt | 3 +++ ...UsingCustomerKeyManagement-updateEncryptionAtRest.txt | 3 +++ ...as-api-encryptionAtRestUsingCustomerKeyManagement.txt | 3 +++ docs/command/atlas-api-events-getOrganizationEvent.txt | 3 +++ docs/command/atlas-api-events-getProjectEvent.txt | 3 +++ docs/command/atlas-api-events-listEventTypes.txt | 3 +++ docs/command/atlas-api-events-listOrganizationEvents.txt | 3 +++ docs/command/atlas-api-events-listProjectEvents.txt | 3 +++ docs/command/atlas-api-events.txt | 3 +++ ...pi-federatedAuthentication-createIdentityProvider.txt | 3 +++ ...las-api-federatedAuthentication-createRoleMapping.txt | 3 +++ ...s-api-federatedAuthentication-deleteFederationApp.txt | 3 +++ ...pi-federatedAuthentication-deleteIdentityProvider.txt | 3 +++ ...las-api-federatedAuthentication-deleteRoleMapping.txt | 3 +++ ...api-federatedAuthentication-getConnectedOrgConfig.txt | 3 +++ ...api-federatedAuthentication-getFederationSettings.txt | 3 +++ ...s-api-federatedAuthentication-getIdentityProvider.txt | 3 +++ ...deratedAuthentication-getIdentityProviderMetadata.txt | 3 +++ .../atlas-api-federatedAuthentication-getRoleMapping.txt | 3 +++ ...i-federatedAuthentication-listConnectedOrgConfigs.txt | 3 +++ ...api-federatedAuthentication-listIdentityProviders.txt | 3 +++ ...tlas-api-federatedAuthentication-listRoleMappings.txt | 3 +++ ...-federatedAuthentication-removeConnectedOrgConfig.txt | 3 +++ ...atedAuthentication-revokeJwksFromIdentityProvider.txt | 3 +++ ...-federatedAuthentication-updateConnectedOrgConfig.txt | 3 +++ ...pi-federatedAuthentication-updateIdentityProvider.txt | 3 +++ ...las-api-federatedAuthentication-updateRoleMapping.txt | 3 +++ docs/command/atlas-api-federatedAuthentication.txt | 5 +++++ .../command/atlas-api-flexClusters-createFlexCluster.txt | 3 +++ .../command/atlas-api-flexClusters-deleteFlexCluster.txt | 3 +++ docs/command/atlas-api-flexClusters-getFlexCluster.txt | 3 +++ docs/command/atlas-api-flexClusters-listFlexClusters.txt | 3 +++ .../command/atlas-api-flexClusters-updateFlexCluster.txt | 3 +++ .../atlas-api-flexClusters-upgradeFlexCluster.txt | 3 +++ docs/command/atlas-api-flexClusters.txt | 5 +++++ ...as-api-flexRestoreJobs-createFlexBackupRestoreJob.txt | 3 +++ ...atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt | 3 +++ ...las-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt | 3 +++ docs/command/atlas-api-flexRestoreJobs.txt | 5 +++++ .../atlas-api-flexSnapshots-downloadFlexBackup.txt | 3 +++ docs/command/atlas-api-flexSnapshots-getFlexBackup.txt | 3 +++ docs/command/atlas-api-flexSnapshots-listFlexBackups.txt | 3 +++ docs/command/atlas-api-flexSnapshots.txt | 5 +++++ .../atlas-api-globalClusters-createCustomZoneMapping.txt | 3 +++ .../atlas-api-globalClusters-createManagedNamespace.txt | 3 +++ ...as-api-globalClusters-deleteAllCustomZoneMappings.txt | 3 +++ .../atlas-api-globalClusters-deleteManagedNamespace.txt | 3 +++ .../atlas-api-globalClusters-getManagedNamespace.txt | 3 +++ docs/command/atlas-api-globalClusters.txt | 3 +++ ...atlas-api-invoices-createCostExplorerQueryProcess.txt | 3 +++ docs/command/atlas-api-invoices-downloadInvoiceCsv.txt | 3 +++ .../atlas-api-invoices-getCostExplorerQueryProcess.txt | 3 +++ docs/command/atlas-api-invoices-getInvoice.txt | 3 +++ docs/command/atlas-api-invoices-listInvoices.txt | 3 +++ docs/command/atlas-api-invoices-listPendingInvoices.txt | 3 +++ ...tlas-api-invoices-queryLineItemsFromSingleInvoice.txt | 3 +++ docs/command/atlas-api-invoices.txt | 5 +++++ ...las-api-ldapConfiguration-deleteLdapConfiguration.txt | 3 +++ .../atlas-api-ldapConfiguration-getLdapConfiguration.txt | 3 +++ ...-api-ldapConfiguration-getLdapConfigurationStatus.txt | 3 +++ ...atlas-api-ldapConfiguration-saveLdapConfiguration.txt | 3 +++ ...las-api-ldapConfiguration-verifyLdapConfiguration.txt | 3 +++ docs/command/atlas-api-ldapConfiguration.txt | 3 +++ ...las-api-legacyBackup-createLegacyBackupRestoreJob.txt | 3 +++ .../atlas-api-legacyBackup-deleteLegacySnapshot.txt | 3 +++ .../atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt | 3 +++ .../atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt | 3 +++ .../command/atlas-api-legacyBackup-getLegacySnapshot.txt | 3 +++ .../atlas-api-legacyBackup-getLegacySnapshotSchedule.txt | 3 +++ ...tlas-api-legacyBackup-listLegacyBackupCheckpoints.txt | 3 +++ ...tlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt | 3 +++ .../atlas-api-legacyBackup-listLegacySnapshots.txt | 3 +++ ...as-api-legacyBackup-updateLegacySnapshotRetention.txt | 3 +++ ...las-api-legacyBackup-updateLegacySnapshotSchedule.txt | 3 +++ docs/command/atlas-api-legacyBackup.txt | 5 +++++ ...las-api-maintenanceWindows-deferMaintenanceWindow.txt | 3 +++ ...atlas-api-maintenanceWindows-getMaintenanceWindow.txt | 3 +++ ...las-api-maintenanceWindows-resetMaintenanceWindow.txt | 3 +++ ...api-maintenanceWindows-toggleMaintenanceAutoDefer.txt | 3 +++ ...as-api-maintenanceWindows-updateMaintenanceWindow.txt | 3 +++ docs/command/atlas-api-maintenanceWindows.txt | 3 +++ .../atlas-api-mongoDbCloudUsers-addOrganizationRole.txt | 3 +++ .../atlas-api-mongoDbCloudUsers-addProjectRole.txt | 3 +++ .../atlas-api-mongoDbCloudUsers-addProjectUser.txt | 3 +++ .../atlas-api-mongoDbCloudUsers-addUserToTeam.txt | 3 +++ ...tlas-api-mongoDbCloudUsers-createOrganizationUser.txt | 3 +++ docs/command/atlas-api-mongoDbCloudUsers-createUser.txt | 3 +++ .../atlas-api-mongoDbCloudUsers-getOrganizationUser.txt | 3 +++ .../atlas-api-mongoDbCloudUsers-getProjectUser.txt | 3 +++ docs/command/atlas-api-mongoDbCloudUsers-getUser.txt | 3 +++ .../atlas-api-mongoDbCloudUsers-getUserByUsername.txt | 3 +++ ...atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt | 3 +++ .../atlas-api-mongoDbCloudUsers-listProjectUsers.txt | 3 +++ .../atlas-api-mongoDbCloudUsers-listTeamUsers.txt | 3 +++ ...tlas-api-mongoDbCloudUsers-removeOrganizationRole.txt | 3 +++ ...tlas-api-mongoDbCloudUsers-removeOrganizationUser.txt | 3 +++ .../atlas-api-mongoDbCloudUsers-removeProjectRole.txt | 3 +++ .../atlas-api-mongoDbCloudUsers-removeProjectUser.txt | 3 +++ .../atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt | 3 +++ ...tlas-api-mongoDbCloudUsers-updateOrganizationUser.txt | 3 +++ docs/command/atlas-api-mongoDbCloudUsers.txt | 5 +++++ .../atlas-api-monitoringAndLogs-getAtlasProcess.txt | 3 +++ docs/command/atlas-api-monitoringAndLogs-getDatabase.txt | 3 +++ ...las-api-monitoringAndLogs-getDatabaseMeasurements.txt | 3 +++ .../atlas-api-monitoringAndLogs-getDiskMeasurements.txt | 3 +++ docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt | 3 +++ .../atlas-api-monitoringAndLogs-getHostMeasurements.txt | 3 +++ .../atlas-api-monitoringAndLogs-getIndexMetrics.txt | 3 +++ .../atlas-api-monitoringAndLogs-getMeasurements.txt | 3 +++ .../atlas-api-monitoringAndLogs-listAtlasProcesses.txt | 3 +++ .../atlas-api-monitoringAndLogs-listDatabases.txt | 3 +++ .../atlas-api-monitoringAndLogs-listDiskMeasurements.txt | 3 +++ .../atlas-api-monitoringAndLogs-listDiskPartitions.txt | 3 +++ .../atlas-api-monitoringAndLogs-listIndexMetrics.txt | 3 +++ .../atlas-api-monitoringAndLogs-listMetricTypes.txt | 3 +++ docs/command/atlas-api-monitoringAndLogs.txt | 5 +++++ .../atlas-api-networkPeering-createPeeringConnection.txt | 3 +++ .../atlas-api-networkPeering-createPeeringContainer.txt | 3 +++ .../atlas-api-networkPeering-deletePeeringConnection.txt | 3 +++ .../atlas-api-networkPeering-deletePeeringContainer.txt | 3 +++ docs/command/atlas-api-networkPeering-disablePeering.txt | 3 +++ .../atlas-api-networkPeering-getPeeringConnection.txt | 3 +++ .../atlas-api-networkPeering-getPeeringContainer.txt | 3 +++ .../atlas-api-networkPeering-listPeeringConnections.txt | 3 +++ ...etworkPeering-listPeeringContainerByCloudProvider.txt | 3 +++ .../atlas-api-networkPeering-listPeeringContainers.txt | 3 +++ .../atlas-api-networkPeering-updatePeeringConnection.txt | 3 +++ .../atlas-api-networkPeering-updatePeeringContainer.txt | 3 +++ ...ring-verifyConnectViaPeeringOnlyModeForOneProject.txt | 3 +++ docs/command/atlas-api-networkPeering.txt | 3 +++ .../atlas-api-onlineArchive-createOnlineArchive.txt | 3 +++ .../atlas-api-onlineArchive-deleteOnlineArchive.txt | 3 +++ ...-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt | 3 +++ .../command/atlas-api-onlineArchive-getOnlineArchive.txt | 3 +++ .../atlas-api-onlineArchive-listOnlineArchives.txt | 3 +++ .../atlas-api-onlineArchive-updateOnlineArchive.txt | 3 +++ docs/command/atlas-api-onlineArchive.txt | 5 +++++ .../atlas-api-organizations-createOrganization.txt | 3 +++ ...as-api-organizations-createOrganizationInvitation.txt | 3 +++ .../atlas-api-organizations-deleteOrganization.txt | 3 +++ ...as-api-organizations-deleteOrganizationInvitation.txt | 3 +++ docs/command/atlas-api-organizations-getOrganization.txt | 3 +++ ...atlas-api-organizations-getOrganizationInvitation.txt | 3 +++ .../atlas-api-organizations-getOrganizationSettings.txt | 3 +++ ...las-api-organizations-listOrganizationInvitations.txt | 3 +++ .../atlas-api-organizations-listOrganizationProjects.txt | 3 +++ .../atlas-api-organizations-listOrganizations.txt | 3 +++ .../atlas-api-organizations-updateOrganization.txt | 3 +++ ...as-api-organizations-updateOrganizationInvitation.txt | 3 +++ ...pi-organizations-updateOrganizationInvitationById.txt | 3 +++ .../atlas-api-organizations-updateOrganizationRoles.txt | 3 +++ ...tlas-api-organizations-updateOrganizationSettings.txt | 3 +++ docs/command/atlas-api-organizations.txt | 5 +++++ ...rformanceAdvisor-disableSlowOperationThresholding.txt | 3 +++ ...erformanceAdvisor-enableSlowOperationThresholding.txt | 3 +++ .../atlas-api-performanceAdvisor-getManagedSlowMs.txt | 3 +++ ...-api-performanceAdvisor-getServerlessAutoIndexing.txt | 3 +++ ...pi-performanceAdvisor-listClusterSuggestedIndexes.txt | 3 +++ .../atlas-api-performanceAdvisor-listDropIndexes.txt | 3 +++ .../atlas-api-performanceAdvisor-listSchemaAdvice.txt | 3 +++ .../atlas-api-performanceAdvisor-listSlowQueries.txt | 3 +++ ...as-api-performanceAdvisor-listSlowQueryNamespaces.txt | 3 +++ ...atlas-api-performanceAdvisor-listSuggestedIndexes.txt | 3 +++ ...-api-performanceAdvisor-setServerlessAutoIndexing.txt | 3 +++ docs/command/atlas-api-performanceAdvisor.txt | 3 +++ ...api-privateEndpointServices-createPrivateEndpoint.txt | 3 +++ ...vateEndpointServices-createPrivateEndpointService.txt | 3 +++ ...api-privateEndpointServices-deletePrivateEndpoint.txt | 3 +++ ...vateEndpointServices-deletePrivateEndpointService.txt | 3 +++ ...as-api-privateEndpointServices-getPrivateEndpoint.txt | 3 +++ ...privateEndpointServices-getPrivateEndpointService.txt | 3 +++ ...intServices-getRegionalizedPrivateEndpointSetting.txt | 3 +++ ...ivateEndpointServices-listPrivateEndpointServices.txt | 3 +++ ...Services-toggleRegionalizedPrivateEndpointSetting.txt | 3 +++ docs/command/atlas-api-privateEndpointServices.txt | 5 +++++ .../atlas-api-programmaticApiKeys-addProjectApiKey.txt | 3 +++ .../atlas-api-programmaticApiKeys-createApiKey.txt | 3 +++ ...as-api-programmaticApiKeys-createApiKeyAccessList.txt | 3 +++ ...atlas-api-programmaticApiKeys-createProjectApiKey.txt | 3 +++ .../atlas-api-programmaticApiKeys-deleteApiKey.txt | 3 +++ ...i-programmaticApiKeys-deleteApiKeyAccessListEntry.txt | 3 +++ docs/command/atlas-api-programmaticApiKeys-getApiKey.txt | 3 +++ ...atlas-api-programmaticApiKeys-getApiKeyAccessList.txt | 3 +++ ...-programmaticApiKeys-listApiKeyAccessListsEntries.txt | 3 +++ .../atlas-api-programmaticApiKeys-listApiKeys.txt | 3 +++ .../atlas-api-programmaticApiKeys-listProjectApiKeys.txt | 3 +++ ...atlas-api-programmaticApiKeys-removeProjectApiKey.txt | 3 +++ .../atlas-api-programmaticApiKeys-updateApiKey.txt | 3 +++ .../atlas-api-programmaticApiKeys-updateApiKeyRoles.txt | 3 +++ docs/command/atlas-api-programmaticApiKeys.txt | 3 +++ ...api-projectIpAccessList-createProjectIpAccessList.txt | 3 +++ ...api-projectIpAccessList-deleteProjectIpAccessList.txt | 3 +++ ...-projectIpAccessList-getProjectIpAccessListStatus.txt | 3 +++ .../atlas-api-projectIpAccessList-getProjectIpList.txt | 3 +++ ...-api-projectIpAccessList-listProjectIpAccessLists.txt | 3 +++ docs/command/atlas-api-projectIpAccessList.txt | 3 +++ docs/command/atlas-api-projects-addUserToProject.txt | 3 +++ docs/command/atlas-api-projects-createProject.txt | 3 +++ .../atlas-api-projects-createProjectInvitation.txt | 3 +++ docs/command/atlas-api-projects-deleteProject.txt | 3 +++ .../atlas-api-projects-deleteProjectInvitation.txt | 3 +++ docs/command/atlas-api-projects-deleteProjectLimit.txt | 3 +++ docs/command/atlas-api-projects-getProject.txt | 3 +++ docs/command/atlas-api-projects-getProjectByName.txt | 3 +++ docs/command/atlas-api-projects-getProjectInvitation.txt | 3 +++ docs/command/atlas-api-projects-getProjectLimit.txt | 3 +++ .../command/atlas-api-projects-getProjectLtsVersions.txt | 3 +++ docs/command/atlas-api-projects-getProjectSettings.txt | 3 +++ .../atlas-api-projects-listProjectInvitations.txt | 3 +++ docs/command/atlas-api-projects-listProjectLimits.txt | 3 +++ docs/command/atlas-api-projects-listProjects.txt | 3 +++ .../atlas-api-projects-migrateProjectToAnotherOrg.txt | 3 +++ docs/command/atlas-api-projects-returnAllIpAddresses.txt | 3 +++ docs/command/atlas-api-projects-setProjectLimit.txt | 3 +++ docs/command/atlas-api-projects-updateProject.txt | 3 +++ .../atlas-api-projects-updateProjectInvitation.txt | 3 +++ .../atlas-api-projects-updateProjectInvitationById.txt | 3 +++ docs/command/atlas-api-projects-updateProjectRoles.txt | 3 +++ .../command/atlas-api-projects-updateProjectSettings.txt | 3 +++ docs/command/atlas-api-projects.txt | 5 +++++ ...ushBasedLogExport-createPushBasedLogConfiguration.txt | 3 +++ ...ushBasedLogExport-deletePushBasedLogConfiguration.txt | 3 +++ ...i-pushBasedLogExport-getPushBasedLogConfiguration.txt | 3 +++ ...ushBasedLogExport-updatePushBasedLogConfiguration.txt | 3 +++ docs/command/atlas-api-pushBasedLogExport.txt | 3 +++ ...eInsights-getGroupClusterQueryShapeInsightDetails.txt | 3 +++ ...nsights-getGroupClusterQueryShapeInsightSummaries.txt | 3 +++ docs/command/atlas-api-queryShapeInsights.txt | 5 +++++ ...tlas-api-resourcePolicies-createOrgResourcePolicy.txt | 3 +++ ...tlas-api-resourcePolicies-deleteOrgResourcePolicy.txt | 3 +++ .../atlas-api-resourcePolicies-getOrgResourcePolicy.txt | 3 +++ ...las-api-resourcePolicies-getResourcesNonCompliant.txt | 3 +++ ...tlas-api-resourcePolicies-listOrgResourcePolicies.txt | 3 +++ ...tlas-api-resourcePolicies-updateOrgResourcePolicy.txt | 3 +++ ...-api-resourcePolicies-validateAtlasResourcePolicy.txt | 3 +++ docs/command/atlas-api-resourcePolicies.txt | 5 +++++ .../atlas-api-rollingIndex-createRollingIndex.txt | 3 +++ docs/command/atlas-api-rollingIndex.txt | 3 +++ docs/command/atlas-api-root-getSystemStatus.txt | 3 +++ .../atlas-api-root-returnAllControlPlaneIpAddresses.txt | 3 +++ docs/command/atlas-api-root.txt | 3 +++ ...-api-serverlessInstances-createServerlessInstance.txt | 3 +++ ...-api-serverlessInstances-deleteServerlessInstance.txt | 3 +++ ...las-api-serverlessInstances-getServerlessInstance.txt | 3 +++ ...s-api-serverlessInstances-listServerlessInstances.txt | 3 +++ ...-api-serverlessInstances-updateServerlessInstance.txt | 3 +++ docs/command/atlas-api-serverlessInstances.txt | 5 +++++ ...sPrivateEndpoints-createServerlessPrivateEndpoint.txt | 3 +++ ...sPrivateEndpoints-deleteServerlessPrivateEndpoint.txt | 3 +++ ...lessPrivateEndpoints-getServerlessPrivateEndpoint.txt | 3 +++ ...ssPrivateEndpoints-listServerlessPrivateEndpoints.txt | 3 +++ ...sPrivateEndpoints-updateServerlessPrivateEndpoint.txt | 3 +++ docs/command/atlas-api-serverlessPrivateEndpoints.txt | 3 +++ ...tlas-api-serviceAccounts-addProjectServiceAccount.txt | 3 +++ ...s-api-serviceAccounts-createProjectServiceAccount.txt | 3 +++ ...iceAccounts-createProjectServiceAccountAccessList.txt | 3 +++ ...serviceAccounts-createProjectServiceAccountSecret.txt | 3 +++ .../atlas-api-serviceAccounts-createServiceAccount.txt | 3 +++ ...pi-serviceAccounts-createServiceAccountAccessList.txt | 3 +++ ...as-api-serviceAccounts-createServiceAccountSecret.txt | 3 +++ ...s-api-serviceAccounts-deleteProjectServiceAccount.txt | 3 +++ ...counts-deleteProjectServiceAccountAccessListEntry.txt | 3 +++ ...serviceAccounts-deleteProjectServiceAccountSecret.txt | 3 +++ .../atlas-api-serviceAccounts-deleteServiceAccount.txt | 3 +++ ...rviceAccounts-deleteServiceAccountAccessListEntry.txt | 3 +++ ...as-api-serviceAccounts-deleteServiceAccountSecret.txt | 3 +++ ...tlas-api-serviceAccounts-getProjectServiceAccount.txt | 3 +++ .../atlas-api-serviceAccounts-getServiceAccount.txt | 3 +++ ...rviceAccounts-listProjectServiceAccountAccessList.txt | 3 +++ ...as-api-serviceAccounts-listProjectServiceAccounts.txt | 3 +++ ...-api-serviceAccounts-listServiceAccountAccessList.txt | 3 +++ ...as-api-serviceAccounts-listServiceAccountProjects.txt | 3 +++ .../atlas-api-serviceAccounts-listServiceAccounts.txt | 3 +++ ...s-api-serviceAccounts-updateProjectServiceAccount.txt | 3 +++ .../atlas-api-serviceAccounts-updateServiceAccount.txt | 3 +++ docs/command/atlas-api-serviceAccounts.txt | 3 +++ ...erRestoreJobs-createSharedClusterBackupRestoreJob.txt | 3 +++ ...dTierRestoreJobs-getSharedClusterBackupRestoreJob.txt | 3 +++ ...ierRestoreJobs-listSharedClusterBackupRestoreJobs.txt | 3 +++ docs/command/atlas-api-sharedTierRestoreJobs.txt | 5 +++++ ...i-sharedTierSnapshots-downloadSharedClusterBackup.txt | 3 +++ ...as-api-sharedTierSnapshots-getSharedClusterBackup.txt | 3 +++ ...-api-sharedTierSnapshots-listSharedClusterBackups.txt | 3 +++ docs/command/atlas-api-sharedTierSnapshots.txt | 5 +++++ .../atlas-api-streams-acceptVpcPeeringConnection.txt | 3 +++ .../atlas-api-streams-createPrivateLinkConnection.txt | 3 +++ .../command/atlas-api-streams-createStreamConnection.txt | 3 +++ docs/command/atlas-api-streams-createStreamInstance.txt | 3 +++ ...streams-createStreamInstanceWithSampleConnections.txt | 3 +++ docs/command/atlas-api-streams-createStreamProcessor.txt | 3 +++ .../atlas-api-streams-deletePrivateLinkConnection.txt | 3 +++ .../command/atlas-api-streams-deleteStreamConnection.txt | 3 +++ docs/command/atlas-api-streams-deleteStreamInstance.txt | 3 +++ docs/command/atlas-api-streams-deleteStreamProcessor.txt | 3 +++ .../atlas-api-streams-deleteVpcPeeringConnection.txt | 3 +++ .../atlas-api-streams-downloadStreamTenantAuditLogs.txt | 3 +++ docs/command/atlas-api-streams-getAccountDetails.txt | 3 +++ .../atlas-api-streams-getActiveVpcPeeringConnections.txt | 3 +++ .../atlas-api-streams-getPrivateLinkConnection.txt | 3 +++ docs/command/atlas-api-streams-getStreamConnection.txt | 3 +++ docs/command/atlas-api-streams-getStreamInstance.txt | 3 +++ docs/command/atlas-api-streams-getStreamProcessor.txt | 3 +++ .../atlas-api-streams-getVpcPeeringConnections.txt | 3 +++ .../atlas-api-streams-listPrivateLinkConnections.txt | 3 +++ docs/command/atlas-api-streams-listStreamConnections.txt | 3 +++ docs/command/atlas-api-streams-listStreamInstances.txt | 3 +++ docs/command/atlas-api-streams-listStreamProcessors.txt | 3 +++ docs/command/atlas-api-streams-modifyStreamProcessor.txt | 3 +++ .../atlas-api-streams-rejectVpcPeeringConnection.txt | 3 +++ docs/command/atlas-api-streams-startStreamProcessor.txt | 3 +++ .../atlas-api-streams-startStreamProcessorWith.txt | 3 +++ docs/command/atlas-api-streams-stopStreamProcessor.txt | 3 +++ .../command/atlas-api-streams-updateStreamConnection.txt | 3 +++ docs/command/atlas-api-streams-updateStreamInstance.txt | 3 +++ docs/command/atlas-api-streams.txt | 3 +++ docs/command/atlas-api-teams-addAllTeamsToProject.txt | 3 +++ docs/command/atlas-api-teams-addTeamUser.txt | 3 +++ docs/command/atlas-api-teams-createTeam.txt | 3 +++ docs/command/atlas-api-teams-deleteTeam.txt | 3 +++ docs/command/atlas-api-teams-getProjectTeam.txt | 3 +++ docs/command/atlas-api-teams-getTeamById.txt | 3 +++ docs/command/atlas-api-teams-getTeamByName.txt | 3 +++ docs/command/atlas-api-teams-listOrganizationTeams.txt | 3 +++ docs/command/atlas-api-teams-listProjectTeams.txt | 3 +++ docs/command/atlas-api-teams-removeProjectTeam.txt | 3 +++ docs/command/atlas-api-teams-removeTeamUser.txt | 3 +++ docs/command/atlas-api-teams-renameTeam.txt | 3 +++ docs/command/atlas-api-teams-updateTeamRoles.txt | 3 +++ docs/command/atlas-api-teams.txt | 5 +++++ ...hirdPartyIntegrations-createThirdPartyIntegration.txt | 3 +++ ...hirdPartyIntegrations-deleteThirdPartyIntegration.txt | 3 +++ ...i-thirdPartyIntegrations-getThirdPartyIntegration.txt | 3 +++ ...thirdPartyIntegrations-listThirdPartyIntegrations.txt | 3 +++ ...hirdPartyIntegrations-updateThirdPartyIntegration.txt | 3 +++ docs/command/atlas-api-thirdPartyIntegrations.txt | 3 +++ ...-x509Authentication-createDatabaseUserCertificate.txt | 3 +++ ...api-x509Authentication-disableCustomerManagedX509.txt | 3 +++ ...i-x509Authentication-listDatabaseUserCertificates.txt | 3 +++ docs/command/atlas-api-x509Authentication.txt | 3 +++ tools/cmd/docs/transformations.go | 9 +++++++++ 493 files changed, 1529 insertions(+) diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt index 8174796bff..f4493dff77 100644 --- a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt +++ b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt @@ -14,6 +14,9 @@ atlas api accessTracking listAccessLogsByClusterName Returns the access logs of one cluster identified by the cluster's name. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. 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-listaccesslogsbyclustername. diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt index 406f1f3074..f19249e7c8 100644 --- a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt +++ b/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt @@ -14,6 +14,9 @@ atlas api accessTracking listAccessLogsByHostname Returns the access logs of one cluster identified by the cluster's hostname. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. 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-listaccesslogsbyhostname. diff --git a/docs/command/atlas-api-accessTracking.txt b/docs/command/atlas-api-accessTracking.txt index 141468e29c..4ee573f23a 100644 --- a/docs/command/atlas-api-accessTracking.txt +++ b/docs/command/atlas-api-accessTracking.txt @@ -14,6 +14,9 @@ atlas api accessTracking Returns access logs for authentication attempts made to Atlas database deployments. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To view database access history, you must have either the Project Owner or Organization Owner role. Options diff --git a/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt index 213264c4a6..5c24fe6204 100644 --- a/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt @@ -14,6 +14,9 @@ atlas api alertConfigurations createAlertConfiguration Creates one alert configuration for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. diff --git a/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt index 5a2cfe54f7..0ce8fd3b4b 100644 --- a/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt @@ -14,6 +14,9 @@ atlas api alertConfigurations deleteAlertConfiguration Removes one alert configuration from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. diff --git a/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt index 573a3e91e4..4091f876b0 100644 --- a/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt @@ -14,6 +14,9 @@ atlas api alertConfigurations getAlertConfiguration Returns the specified alert configuration from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt index 70e41e754b..13a8527c8e 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt @@ -14,6 +14,9 @@ atlas api alertConfigurations listAlertConfigurationMatchersFieldNames Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can successfully call this endpoint with any assigned role. 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-listalertconfigurationmatchersfieldnames. diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt index e59af1e498..da1f1138e7 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt @@ -14,6 +14,9 @@ atlas api alertConfigurations listAlertConfigurations Returns all alert configurations for one project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt index 5e712ef327..81acc53c7f 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt @@ -14,6 +14,9 @@ atlas api alertConfigurations listAlertConfigurationsByAlertId Returns all alert configurations set for the specified alert. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. diff --git a/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt index 6c76d1d740..74400a1f09 100644 --- a/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt @@ -14,6 +14,9 @@ atlas api alertConfigurations toggleAlertConfiguration Enables or disables the specified alert configuration in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. diff --git a/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt index fa669bc440..255ca50863 100644 --- a/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt @@ -14,6 +14,9 @@ atlas api alertConfigurations updateAlertConfiguration Updates one alert configuration in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. diff --git a/docs/command/atlas-api-alertConfigurations.txt b/docs/command/atlas-api-alertConfigurations.txt index 10e906633d..0156575795 100644 --- a/docs/command/atlas-api-alertConfigurations.txt +++ b/docs/command/atlas-api-alertConfigurations.txt @@ -14,6 +14,9 @@ atlas api alertConfigurations Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This collection remains under revision and may change. Options diff --git a/docs/command/atlas-api-alerts-acknowledgeAlert.txt b/docs/command/atlas-api-alerts-acknowledgeAlert.txt index d92f59c1d2..4ac2ca830c 100644 --- a/docs/command/atlas-api-alerts-acknowledgeAlert.txt +++ b/docs/command/atlas-api-alerts-acknowledgeAlert.txt @@ -14,6 +14,9 @@ atlas api alerts acknowledgeAlert Confirms receipt of one existing alert. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. diff --git a/docs/command/atlas-api-alerts-getAlert.txt b/docs/command/atlas-api-alerts-getAlert.txt index e6e2553be3..9371563310 100644 --- a/docs/command/atlas-api-alerts-getAlert.txt +++ b/docs/command/atlas-api-alerts-getAlert.txt @@ -14,6 +14,9 @@ atlas api alerts getAlert Returns one alert. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. diff --git a/docs/command/atlas-api-alerts-listAlerts.txt b/docs/command/atlas-api-alerts-listAlerts.txt index 308f922521..96dd2e2dde 100644 --- a/docs/command/atlas-api-alerts-listAlerts.txt +++ b/docs/command/atlas-api-alerts-listAlerts.txt @@ -14,6 +14,9 @@ atlas api alerts listAlerts Returns all alerts. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt b/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt index 55172b7ed3..58e84e5911 100644 --- a/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt +++ b/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt @@ -14,6 +14,9 @@ atlas api alerts listAlertsByAlertConfigurationId Returns all open alerts that the specified alert configuration triggers. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. diff --git a/docs/command/atlas-api-alerts.txt b/docs/command/atlas-api-alerts.txt index a0203f50b3..027a81d391 100644 --- a/docs/command/atlas-api-alerts.txt +++ b/docs/command/atlas-api-alerts.txt @@ -14,6 +14,9 @@ atlas api alerts Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This collection remains under revision and may change. Options diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt index 531e1ba68b..f36a8bce76 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt @@ -14,6 +14,9 @@ atlas api atlasSearch createAtlasSearchDeployment Creates Search Nodes for the specified cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-createatlassearchdeployment. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt index 1cbd58b482..e28884cbc8 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt @@ -14,6 +14,9 @@ atlas api atlasSearch createAtlasSearchIndex Creates one Atlas Search index on the specified collection. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. 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-createatlassearchindex. diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt index b04d90a93e..b34cd1acd5 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt @@ -14,6 +14,9 @@ atlas api atlasSearch createAtlasSearchIndexDeprecated Creates one Atlas Search index on the specified collection. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. 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-createatlassearchindexdeprecated. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt index 7b7cc8d6a6..e162a2d316 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt @@ -14,6 +14,9 @@ atlas api atlasSearch deleteAtlasSearchDeployment Deletes the Search Nodes for the specified cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-deleteatlassearchdeployment. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt index dea490521c..44c38d2c31 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt @@ -14,6 +14,9 @@ atlas api atlasSearch deleteAtlasSearchIndex Removes one Atlas Search index that you identified with its unique ID. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. 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-deleteatlassearchindex. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt index b1c4b11529..ef360863f2 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt @@ -14,6 +14,9 @@ atlas api atlasSearch deleteAtlasSearchIndexByName Removes one Atlas Search index that you identified with its database, collection, and name. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. 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-deleteatlassearchindexbyname. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt index d022eed0f0..46cb34018b 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt @@ -14,6 +14,9 @@ atlas api atlasSearch deleteAtlasSearchIndexDeprecated Removes one Atlas Search index that you identified with its unique ID. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. 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-deleteatlassearchindexdeprecated. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt index 00231d9aaa..051da89bf3 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt @@ -14,6 +14,9 @@ atlas api atlasSearch getAtlasSearchDeployment Returns the Search Nodes for the specified cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getatlassearchdeployment. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt index dadcf6f3ff..28db6b1647 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt @@ -14,6 +14,9 @@ atlas api atlasSearch getAtlasSearchIndex Returns one Atlas Search index that you identified with its unique ID. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. 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-getatlassearchindex. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt index 5eaadcd6fb..d2de7dfe87 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt @@ -14,6 +14,9 @@ atlas api atlasSearch getAtlasSearchIndexByName Returns one Atlas Search index that you identified with its database, collection name, and index name. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. 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-getatlassearchindexbyname. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt index 900000bca9..480fe655d3 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt @@ -14,6 +14,9 @@ atlas api atlasSearch getAtlasSearchIndexDeprecated Returns one Atlas Search index in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. 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-getatlassearchindexdeprecated. diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt index feb8fec8b2..53951080f9 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt @@ -14,6 +14,9 @@ atlas api atlasSearch listAtlasSearchIndexes Returns all Atlas Search indexes on the specified collection. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. 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-listatlassearchindexes. diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt index 217ce05fec..78a4c11527 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt @@ -14,6 +14,9 @@ atlas api atlasSearch listAtlasSearchIndexesCluster Returns all Atlas Search indexes on the specified cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. 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-listatlassearchindexescluster. diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt index 8de069c38e..751c1c8e23 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt @@ -14,6 +14,9 @@ atlas api atlasSearch listAtlasSearchIndexesDeprecated Returns all Atlas Search indexes on the specified collection. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. 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-listatlassearchindexesdeprecated. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt index 751b8d5dde..f4db1b8fbe 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt @@ -14,6 +14,9 @@ atlas api atlasSearch updateAtlasSearchDeployment Updates the Search Nodes for the specified cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-updateatlassearchdeployment. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt index b4cb0ed538..0dd6f7a466 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt @@ -14,6 +14,9 @@ atlas api atlasSearch updateAtlasSearchIndex Updates one Atlas Search index that you identified with its unique ID. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-updateatlassearchindex. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt index c13926a77c..47bb9b99e2 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt @@ -14,6 +14,9 @@ atlas api atlasSearch updateAtlasSearchIndexByName Updates one Atlas Search index that you identified with its database, collection name, and index name. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-updateatlassearchindexbyname. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt index 9afc1fe9f3..08dc989ab3 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt @@ -14,6 +14,9 @@ atlas api atlasSearch updateAtlasSearchIndexDeprecated Updates one Atlas Search index that you identified with its unique ID. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-updateatlassearchindexdeprecated. diff --git a/docs/command/atlas-api-atlasSearch.txt b/docs/command/atlas-api-atlasSearch.txt index bede8c5aed..6d802f186a 100644 --- a/docs/command/atlas-api-atlasSearch.txt +++ b/docs/command/atlas-api-atlasSearch.txt @@ -14,6 +14,9 @@ atlas api atlasSearch Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Also returns and updates user-defined analyzers for the specified cluster. Options diff --git a/docs/command/atlas-api-auditing-getAuditingConfiguration.txt b/docs/command/atlas-api-auditing-getAuditingConfiguration.txt index 2330eb7a6d..5225c8fa65 100644 --- a/docs/command/atlas-api-auditing-getAuditingConfiguration.txt +++ b/docs/command/atlas-api-auditing-getAuditingConfiguration.txt @@ -14,6 +14,9 @@ atlas api auditing getAuditingConfiguration Returns the auditing configuration for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-getauditingconfiguration. diff --git a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt b/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt index f083ed4d05..d766bfc435 100644 --- a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt +++ b/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt @@ -14,6 +14,9 @@ atlas api auditing updateAuditingConfiguration Updates the auditing configuration for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-updateauditingconfiguration. diff --git a/docs/command/atlas-api-auditing.txt b/docs/command/atlas-api-auditing.txt index 64cabd3b04..b73bb08a23 100644 --- a/docs/command/atlas-api-auditing.txt +++ b/docs/command/atlas-api-auditing.txt @@ -14,6 +14,11 @@ atlas api auditing Returns and edits database auditing settings for MongoDB Cloud projects. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt b/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt index b5132b2718..cdc6169d27 100644 --- a/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt +++ b/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt @@ -14,6 +14,9 @@ atlas api awsClustersDns getAwsCustomDns Returns the custom DNS configuration for AWS clusters in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getawscustomdns. diff --git a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt index 6b14069cba..f85fd1c6b5 100644 --- a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt +++ b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt @@ -14,6 +14,9 @@ atlas api awsClustersDns toggleAwsCustomDns Enables or disables the custom DNS configuration for AWS clusters in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Enable custom DNS if you use AWS VPC peering and use your own DNS servers. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. 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-toggleawscustomdns. diff --git a/docs/command/atlas-api-awsClustersDns.txt b/docs/command/atlas-api-awsClustersDns.txt index 9cfff03a75..8c750a3c4e 100644 --- a/docs/command/atlas-api-awsClustersDns.txt +++ b/docs/command/atlas-api-awsClustersDns.txt @@ -14,6 +14,9 @@ atlas api awsClustersDns Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The resource requires your Project ID. If you use the VPC peering on AWS and you use your own DNS servers instead of Amazon Route 53, enable custom DNS. Before 31 March 2020, applications deployed within AWS using custom DNS services and VPC-peered with MongoDB Cloud couldn't connect over private IP addresses. Custom DNS resolved to public IP addresses. AWS internal DNS resolved to private IP addresses. Applications deployed with custom DNS services in AWS should use Private IP for Peering connection strings. Options diff --git a/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt index 69e53c5b35..1beadd9e6c 100644 --- a/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt @@ -14,6 +14,9 @@ atlas api cloudBackups cancelBackupRestoreJob Cancels one cloud backup restore job of one cluster from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. 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-cancelbackuprestorejob. diff --git a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt index c8ef224323..4f8a7e19b2 100644 --- a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt +++ b/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt @@ -14,6 +14,9 @@ atlas api cloudBackups createBackupExportJob Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. 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-createbackupexportjob. diff --git a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt index 729d2cb62b..bd4d30534b 100644 --- a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt @@ -14,6 +14,9 @@ atlas api cloudBackups createBackupRestoreJob Restores one snapshot of one cluster from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. diff --git a/docs/command/atlas-api-cloudBackups-createExportBucket.txt b/docs/command/atlas-api-cloudBackups-createExportBucket.txt index 106b01b022..2993b72546 100644 --- a/docs/command/atlas-api-cloudBackups-createExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-createExportBucket.txt @@ -14,6 +14,9 @@ atlas api cloudBackups createExportBucket Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-createexportbucket. diff --git a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt index 3d88f5f3f3..204519bc6e 100644 --- a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt @@ -14,6 +14,9 @@ atlas api cloudBackups createServerlessBackupRestoreJob Restores one snapshot of one serverless instance from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt b/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt index 5fd8cf71c5..373f8bd8fb 100644 --- a/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt +++ b/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt @@ -14,6 +14,9 @@ atlas api cloudBackups deleteAllBackupSchedules Removes all cloud backup schedules for the specified cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. 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-deleteallbackupschedules. diff --git a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt index 105cef8633..29d083e8e4 100644 --- a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt @@ -14,6 +14,9 @@ atlas api cloudBackups deleteExportBucket Deletes an Export Bucket. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. 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-deleteexportbucket. diff --git a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt index 03a301aedb..c209b88f2d 100644 --- a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt +++ b/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt @@ -14,6 +14,9 @@ atlas api cloudBackups deleteReplicaSetBackup Removes the specified snapshot. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. 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-deletereplicasetbackup. diff --git a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt index 82e88ddf00..8dc85958da 100644 --- a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt +++ b/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt @@ -14,6 +14,9 @@ atlas api cloudBackups deleteShardedClusterBackup Removes one snapshot of one sharded cluster from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. 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-deleteshardedclusterbackup. diff --git a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt index ba85cd2dcc..7198adf20a 100644 --- a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt @@ -14,6 +14,9 @@ atlas api cloudBackups disableDataProtectionSettings Disables the Backup Compliance Policy settings with the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + As a prerequisite, a support ticket needs to be file first, instructions in https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-disabledataprotectionsettings. diff --git a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt index b6a95fb081..dccd55ea7c 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt @@ -14,6 +14,9 @@ atlas api cloudBackups getBackupExportJob Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. 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-getbackupexportjob. diff --git a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt index 17563d7443..5a80391bed 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt @@ -14,6 +14,9 @@ atlas api cloudBackups getBackupRestoreJob Returns one cloud backup restore job for one cluster from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. 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-getbackuprestorejob. diff --git a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt index 6f4e10da74..942c155820 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt @@ -14,6 +14,9 @@ atlas api cloudBackups getBackupSchedule Returns the cloud backup schedule for the specified cluster within the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getbackupschedule. diff --git a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt index a08cb60027..d31b519529 100644 --- a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt @@ -14,6 +14,9 @@ atlas api cloudBackups getDataProtectionSettings Returns the Backup Compliance Policy settings with the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-getdataprotectionsettings. diff --git a/docs/command/atlas-api-cloudBackups-getExportBucket.txt b/docs/command/atlas-api-cloudBackups-getExportBucket.txt index 78c90e9384..ab94755a8d 100644 --- a/docs/command/atlas-api-cloudBackups-getExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-getExportBucket.txt @@ -14,6 +14,9 @@ atlas api cloudBackups getExportBucket Returns one Export Bucket associated with the specified Project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getexportbucket. diff --git a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt index cc082bcb73..b4ebc3a905 100644 --- a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt @@ -14,6 +14,9 @@ atlas api cloudBackups getReplicaSetBackup Returns one snapshot from the specified cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. 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-getreplicasetbackup. diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt index 56be34a6a4..0fa6b99538 100644 --- a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt @@ -14,6 +14,9 @@ atlas api cloudBackups getServerlessBackup Returns one snapshot of one serverless instance from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt index 30037495b0..bf58a7f4fb 100644 --- a/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt @@ -14,6 +14,9 @@ atlas api cloudBackups getServerlessBackupRestoreJob Returns one restore job for one serverless instance from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt index 24e86e97d1..69414aa990 100644 --- a/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt @@ -14,6 +14,9 @@ atlas api cloudBackups getShardedClusterBackup Returns one snapshot of one sharded cluster from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. 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-getshardedclusterbackup. diff --git a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt index 9ca305b003..c2c3d2518b 100644 --- a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt @@ -14,6 +14,9 @@ atlas api cloudBackups listBackupExportJobs Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. 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-listbackupexportjobs. diff --git a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt index a670c5f112..f44fc1f293 100644 --- a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt @@ -14,6 +14,9 @@ atlas api cloudBackups listBackupRestoreJobs Returns all cloud backup restore jobs for one cluster from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. 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-listbackuprestorejobs. diff --git a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt index 766eeed0db..6dc359a3d8 100644 --- a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt +++ b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt @@ -14,6 +14,9 @@ atlas api cloudBackups listExportBuckets Returns all Export Buckets associated with the specified Project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listexportbuckets. diff --git a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt b/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt index e5dcca7987..2d6db0aae4 100644 --- a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt @@ -14,6 +14,9 @@ atlas api cloudBackups listReplicaSetBackups Returns all snapshots of one cluster from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. 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-listreplicasetbackups. diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt index 4cdbedc112..f566bc504c 100644 --- a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt @@ -14,6 +14,9 @@ atlas api cloudBackups listServerlessBackupRestoreJobs Returns all restore jobs for one serverless instance from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt index a2e3658e36..3d1c50c656 100644 --- a/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt @@ -14,6 +14,9 @@ atlas api cloudBackups listServerlessBackups Returns all snapshots of one serverless instance from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt b/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt index 98c8ed1d64..75556fe853 100644 --- a/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt @@ -14,6 +14,9 @@ atlas api cloudBackups listShardedClusterBackups Returns all snapshots of one sharded cluster from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. 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-listshardedclusterbackups. diff --git a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt b/docs/command/atlas-api-cloudBackups-takeSnapshot.txt index 3f7e947b65..a3c7916828 100644 --- a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt +++ b/docs/command/atlas-api-cloudBackups-takeSnapshot.txt @@ -14,6 +14,9 @@ atlas api cloudBackups takeSnapshot Takes one on-demand snapshot for the specified cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. diff --git a/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt index 17f5418a67..1ca3c320ea 100644 --- a/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt +++ b/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt @@ -14,6 +14,9 @@ atlas api cloudBackups updateBackupSchedule Updates the cloud backup schedule for one cluster within the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-updatebackupschedule. diff --git a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt index 534419a05a..9cde54f9c1 100644 --- a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt @@ -14,6 +14,9 @@ atlas api cloudBackups updateDataProtectionSettings Updates the Backup Compliance Policy settings for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-updatedataprotectionsettings. diff --git a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt b/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt index f3fbfd3b6a..1854084bc7 100644 --- a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt +++ b/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt @@ -14,6 +14,9 @@ atlas api cloudBackups updateSnapshotRetention Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The requesting API Key must have the Project Backup Manager role. 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-updatesnapshotretention. diff --git a/docs/command/atlas-api-cloudBackups.txt b/docs/command/atlas-api-cloudBackups.txt index e4eca8685f..631a3ee519 100644 --- a/docs/command/atlas-api-cloudBackups.txt +++ b/docs/command/atlas-api-cloudBackups.txt @@ -14,6 +14,9 @@ atlas api cloudBackups Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This resource applies only to clusters that use Cloud Backups. Options diff --git a/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt b/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt index 04803b3074..2f4cfbc442 100644 --- a/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt +++ b/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt @@ -14,6 +14,9 @@ atlas api cloudMigrationService createLinkToken Create one link-token that contains all the information required to complete the link. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + MongoDB Atlas uses the link-token for push live migrations only. Live migration (push) allows you to securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. 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-createlinktoken. diff --git a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt index 99e2459cad..cd780a40a4 100644 --- a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt @@ -14,6 +14,9 @@ atlas api cloudMigrationService createPushMigration Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Please make sure to validate your migration before initiating it. diff --git a/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt b/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt index dec9511271..7607b8cf8a 100644 --- a/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt @@ -14,6 +14,9 @@ atlas api cloudMigrationService cutoverMigration Cut over the migrated cluster to MongoDB Atlas. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Confirm when the cut over completes. When the cut over completes, MongoDB Atlas completes the live migration process and stops synchronizing with the source cluster. Your API Key must have the Organization Owner role to successfully call this resource. 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-cutovermigration. diff --git a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt b/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt index bf9692726e..9e43c02bbf 100644 --- a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt +++ b/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt @@ -14,6 +14,9 @@ atlas api cloudMigrationService deleteLinkToken Remove one organization link and its associated public API key. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. 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-deletelinktoken. diff --git a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt index 565a0112e0..baa78ac407 100644 --- a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt @@ -14,6 +14,9 @@ atlas api cloudMigrationService getPushMigration Return details of one cluster migration job. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Each push live migration job uses one migration host. Your API Key must have the Organization Member role to successfully call this resource. 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-getpushmigration. diff --git a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt b/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt index 8ccb9ede96..91e39d876a 100644 --- a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt +++ b/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt @@ -14,6 +14,9 @@ atlas api cloudMigrationService getValidationStatus Return the status of one migration validation job. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Your API Key must have the Organization Owner role to successfully call this resource. 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-getvalidationstatus. diff --git a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt b/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt index 1d23a6a1ea..982db593d5 100644 --- a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt +++ b/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt @@ -14,6 +14,9 @@ atlas api cloudMigrationService listSourceProjects Return all projects that you can migrate to the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-listsourceprojects. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-cloudMigrationService-validateMigration.txt b/docs/command/atlas-api-cloudMigrationService-validateMigration.txt index baad21ea84..a77363dd29 100644 --- a/docs/command/atlas-api-cloudMigrationService-validateMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-validateMigration.txt @@ -14,6 +14,9 @@ atlas api cloudMigrationService validateMigration Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + If the check passes, the migration can proceed. Your API Key must have the Organization Owner role to successfully call this resource. 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-validatemigration. diff --git a/docs/command/atlas-api-cloudMigrationService.txt b/docs/command/atlas-api-cloudMigrationService.txt index 338eec7c3a..02c0a011c4 100644 --- a/docs/command/atlas-api-cloudMigrationService.txt +++ b/docs/command/atlas-api-cloudMigrationService.txt @@ -14,6 +14,9 @@ atlas api cloudMigrationService Manages the Cloud Migration Service. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Source organizations, projects, and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations, projects, and MongoDB clusters reside on MongoDB Cloud. Source databases can't use any authentication except SCRAM-SHA. Options diff --git a/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt index 523e607ab2..ede25ccad0 100644 --- a/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt @@ -14,6 +14,9 @@ atlas api cloudProviderAccess authorizeCloudProviderAccessRole Grants access to the specified project for the specified access role. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. This is not required for GCP service account access. 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-authorizecloudprovideraccessrole. diff --git a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt index e2d533aa13..820814d4dc 100644 --- a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt @@ -14,6 +14,9 @@ atlas api cloudProviderAccess createCloudProviderAccessRole Creates one access role for the specified cloud provider. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +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. 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-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt index 5d2221e6dd..493c6b5f2d 100644 --- a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt @@ -14,6 +14,9 @@ atlas api cloudProviderAccess deauthorizeCloudProviderAccessRole Revokes access to the specified project for the specified access role. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-deauthorizecloudprovideraccessrole. diff --git a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt index 6a2219699b..c8dffe24cb 100644 --- a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt @@ -14,6 +14,9 @@ atlas api cloudProviderAccess getCloudProviderAccessRole Returns the access role with the specified id and with access to the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-getcloudprovideraccessrole. diff --git a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt index 375aff1703..77767412f1 100644 --- a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt +++ b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt @@ -14,6 +14,9 @@ atlas api cloudProviderAccess listCloudProviderAccessRoles Returns all cloud provider access roles with access to the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-listcloudprovideraccessroles. diff --git a/docs/command/atlas-api-cloudProviderAccess.txt b/docs/command/atlas-api-cloudProviderAccess.txt index a22dbd2df1..26d6a05ff3 100644 --- a/docs/command/atlas-api-cloudProviderAccess.txt +++ b/docs/command/atlas-api-cloudProviderAccess.txt @@ -14,6 +14,11 @@ atlas api cloudProviderAccess Returns, adds, authorizes, and removes AWS IAM roles in Atlas. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt index 0454b4ed8c..dcfb0e701b 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt @@ -14,6 +14,9 @@ atlas api clusterOutageSimulation endOutageSimulation Ends a cluster outage simulation. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-endoutagesimulation. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt index 34d41160aa..c51d6c25cf 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt @@ -14,6 +14,9 @@ atlas api clusterOutageSimulation getOutageSimulation Returns one outage simulation for one cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getoutagesimulation. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt index 26e435c46f..e19c61fc1a 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt @@ -14,6 +14,9 @@ atlas api clusterOutageSimulation startOutageSimulation Starts a cluster outage simulation. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-startoutagesimulation. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-clusterOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation.txt index 18624d4d62..5c6a5aee0e 100644 --- a/docs/command/atlas-api-clusterOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation.txt @@ -14,6 +14,11 @@ atlas api clusterOutageSimulation Returns, starts, or ends a cluster outage simulation. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-clusters-autoScalingConfiguration.txt b/docs/command/atlas-api-clusters-autoScalingConfiguration.txt index 0729cfdd91..a3dc4f97eb 100644 --- a/docs/command/atlas-api-clusters-autoScalingConfiguration.txt +++ b/docs/command/atlas-api-clusters-autoScalingConfiguration.txt @@ -14,6 +14,9 @@ atlas api clusters autoScalingConfiguration Returns the internal configuration of AutoScaling for sharded clusters. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This endpoint can be used for diagnostic purposes to ensure that sharded clusters updated from older APIs have gained support for AutoScaling each shard independently. 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-autoscalingconfiguration. diff --git a/docs/command/atlas-api-clusters-createCluster.txt b/docs/command/atlas-api-clusters-createCluster.txt index 489063094d..3aa45b9373 100644 --- a/docs/command/atlas-api-clusters-createCluster.txt +++ b/docs/command/atlas-api-clusters-createCluster.txt @@ -14,6 +14,9 @@ atlas api clusters createCluster Creates one cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature is not available for serverless clusters. diff --git a/docs/command/atlas-api-clusters-deleteCluster.txt b/docs/command/atlas-api-clusters-deleteCluster.txt index 663745784c..6598a93aa8 100644 --- a/docs/command/atlas-api-clusters-deleteCluster.txt +++ b/docs/command/atlas-api-clusters-deleteCluster.txt @@ -14,6 +14,9 @@ atlas api clusters deleteCluster Removes one cluster from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature is not available for serverless clusters. diff --git a/docs/command/atlas-api-clusters-getCluster.txt b/docs/command/atlas-api-clusters-getCluster.txt index 4e692e1f0c..9604a8a382 100644 --- a/docs/command/atlas-api-clusters-getCluster.txt +++ b/docs/command/atlas-api-clusters-getCluster.txt @@ -14,6 +14,9 @@ atlas api clusters getCluster Returns the details for one cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This feature is not available for serverless clusters. diff --git a/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt index b7b6c8b6c9..a51eac7571 100644 --- a/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt +++ b/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt @@ -14,6 +14,9 @@ atlas api clusters getClusterAdvancedConfiguration Returns the advanced configuration details for one cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getclusteradvancedconfiguration. diff --git a/docs/command/atlas-api-clusters-getClusterStatus.txt b/docs/command/atlas-api-clusters-getClusterStatus.txt index de110aaf70..b8269aafd7 100644 --- a/docs/command/atlas-api-clusters-getClusterStatus.txt +++ b/docs/command/atlas-api-clusters-getClusterStatus.txt @@ -14,6 +14,9 @@ atlas api clusters getClusterStatus Returns the status of all changes that you made to the specified cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getclusterstatus. diff --git a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt b/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt index e2ce139265..8f58b41ff9 100644 --- a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt +++ b/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt @@ -14,6 +14,9 @@ atlas api clusters getSampleDatasetLoadStatus Checks the progress of loading the sample dataset into one cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-getsampledatasetloadstatus. diff --git a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt index a166891731..72c69ca137 100644 --- a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt +++ b/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt @@ -14,6 +14,9 @@ atlas api clusters grantMongoDbEmployeeAccess Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-grantmongodbemployeeaccess. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-clusters-listCloudProviderRegions.txt b/docs/command/atlas-api-clusters-listCloudProviderRegions.txt index 2c8ca89bbf..78713c68d6 100644 --- a/docs/command/atlas-api-clusters-listCloudProviderRegions.txt +++ b/docs/command/atlas-api-clusters-listCloudProviderRegions.txt @@ -14,6 +14,9 @@ atlas api clusters listCloudProviderRegions Returns the list of regions available for the specified cloud provider at the specified tier. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listcloudproviderregions. diff --git a/docs/command/atlas-api-clusters-listClusters.txt b/docs/command/atlas-api-clusters-listClusters.txt index 5b79a1d619..a2b8ad4770 100644 --- a/docs/command/atlas-api-clusters-listClusters.txt +++ b/docs/command/atlas-api-clusters-listClusters.txt @@ -14,6 +14,9 @@ atlas api clusters listClusters Returns the details for all clusters in the specific project to which you have access. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This feature is not available for serverless clusters. diff --git a/docs/command/atlas-api-clusters-listClustersForAllProjects.txt b/docs/command/atlas-api-clusters-listClustersForAllProjects.txt index 901c2b2a4b..d786c09da6 100644 --- a/docs/command/atlas-api-clusters-listClustersForAllProjects.txt +++ b/docs/command/atlas-api-clusters-listClustersForAllProjects.txt @@ -14,6 +14,9 @@ atlas api clusters listClustersForAllProjects Returns the details for all clusters in all projects to which you have access. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting Service Account or API Key can have any cluster-level role. 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-listclustersforallprojects. diff --git a/docs/command/atlas-api-clusters-loadSampleDataset.txt b/docs/command/atlas-api-clusters-loadSampleDataset.txt index 37b6305593..c41cb31d66 100644 --- a/docs/command/atlas-api-clusters-loadSampleDataset.txt +++ b/docs/command/atlas-api-clusters-loadSampleDataset.txt @@ -14,6 +14,9 @@ atlas api clusters loadSampleDataset Requests loading the MongoDB sample dataset into the specified cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-loadsampledataset. diff --git a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt index 2a6bce1e2e..ddcb481336 100644 --- a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt +++ b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt @@ -14,6 +14,9 @@ atlas api clusters pinFeatureCompatibilityVersion Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + If an FCV pin already exists for the cluster, calling this method will only update the expiration date of the existing pin and will not repin the FCV. 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-pinfeaturecompatibilityversion. diff --git a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt index 3412f4a3f8..7271eb7093 100644 --- a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt +++ b/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt @@ -14,6 +14,9 @@ atlas api clusters revokeMongoDbEmployeeAccess Revokes a previously granted MongoDB employee cluster access. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-revokemongodbemployeeaccess. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-clusters-testFailover.txt b/docs/command/atlas-api-clusters-testFailover.txt index 7182dbd2e0..03a6941d74 100644 --- a/docs/command/atlas-api-clusters-testFailover.txt +++ b/docs/command/atlas-api-clusters-testFailover.txt @@ -14,6 +14,9 @@ atlas api clusters testFailover Starts a failover test for the specified cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. 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-testfailover. diff --git a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt index 142cdfdd5e..b0f477f791 100644 --- a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt +++ b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt @@ -14,6 +14,9 @@ atlas api clusters unpinFeatureCompatibilityVersion Unpins the current fixed Feature Compatibility Version (FCV). +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This feature is not available for clusters on rapid release. 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-unpinfeaturecompatibilityversion. diff --git a/docs/command/atlas-api-clusters-updateCluster.txt b/docs/command/atlas-api-clusters-updateCluster.txt index ebcb9722cb..73eadd9d80 100644 --- a/docs/command/atlas-api-clusters-updateCluster.txt +++ b/docs/command/atlas-api-clusters-updateCluster.txt @@ -14,6 +14,9 @@ atlas api clusters updateCluster Updates the details for one cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Clusters contain a group of hosts that maintain the same data set. This resource can update clusters with asymmetrically-sized shards. To update a cluster's termination protection, the requesting Service Account or API Key must have the Project Owner role. For all other updates, the requesting Service Account or API Key must have the Project Cluster Manager role. You can't modify a paused cluster (paused : true). You must call this endpoint to set paused : false. After this endpoint responds with paused : false, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters. 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-updatecluster. diff --git a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt index d1dd9b5138..999324ad2f 100644 --- a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt +++ b/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt @@ -14,6 +14,9 @@ atlas api clusters updateClusterAdvancedConfiguration Updates the advanced configuration details for one cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. 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-updateclusteradvancedconfiguration. diff --git a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt b/docs/command/atlas-api-clusters-upgradeSharedCluster.txt index a9be193840..b539a581c3 100644 --- a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt +++ b/docs/command/atlas-api-clusters-upgradeSharedCluster.txt @@ -14,6 +14,9 @@ atlas api clusters upgradeSharedCluster Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. Each project supports up to 25 clusters. diff --git a/docs/command/atlas-api-clusters.txt b/docs/command/atlas-api-clusters.txt index a28573c2a3..1a1ef9cce6 100644 --- a/docs/command/atlas-api-clusters.txt +++ b/docs/command/atlas-api-clusters.txt @@ -14,6 +14,9 @@ atlas api clusters Returns, adds, edits, and removes database deployments. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Changes to cluster configurations can affect costs. This resource requires your Project ID. Options diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt index 8cbf2640fe..a0ce6af2e1 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt @@ -14,6 +14,9 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceClusterMeasurements Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getcollstatslatencynamespaceclustermeasurements. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt index a0dc0a9bfa..e4bda133fa 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt @@ -14,6 +14,9 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceHostMeasurements Get a list of the Coll Stats Latency process-level measurements for the given namespace. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getcollstatslatencynamespacehostmeasurements. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt index 6dbedce858..b6376f0eae 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt @@ -14,6 +14,9 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceMetrics Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getcollstatslatencynamespacemetrics. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt index 370be29a9a..97dd6fba93 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt @@ -14,6 +14,9 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForCluster Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getcollstatslatencynamespacesforcluster. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt index 25b0035da2..106c8c4ed5 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt @@ -14,6 +14,9 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForHost Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getcollstatslatencynamespacesforhost. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt index ff1df5759f..a462d9715c 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt @@ -14,6 +14,9 @@ atlas api collectionLevelMetrics getPinnedNamespaces Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getpinnednamespaces. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt index 89b6ffd5eb..7a7e755c71 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt @@ -14,6 +14,9 @@ atlas api collectionLevelMetrics pinNamespacesPatch Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-pinnamespacespatch. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt index 7f80c2ea3d..4cc7da3f9e 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt @@ -14,6 +14,9 @@ atlas api collectionLevelMetrics pinNamespacesPut Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This initializes a pinned namespaces list or replaces any existing pinned namespaces list for the Group and Cluster. 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-pinnamespacesput. diff --git a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt index 5ed7b97b1e..61ccbfd70c 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt @@ -14,6 +14,9 @@ atlas api collectionLevelMetrics unpinNamespaces Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-unpinnamespaces. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-collectionLevelMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics.txt index a5bd5c504a..372d532800 100644 --- a/docs/command/atlas-api-collectionLevelMetrics.txt +++ b/docs/command/atlas-api-collectionLevelMetrics.txt @@ -14,6 +14,9 @@ atlas api collectionLevelMetrics Returns, adds, and edits pinned namespaces for the specified cluster or process. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Also returns collection level latency metric data. Options diff --git a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt index de7c9f352b..483eea15fd 100644 --- a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt @@ -14,6 +14,9 @@ atlas api customDatabaseRoles createCustomDatabaseRole Creates one custom role in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. 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-createcustomdatabaserole. diff --git a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt index 45ed27b0e7..ff57f0986c 100644 --- a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt @@ -14,6 +14,9 @@ atlas api customDatabaseRoles deleteCustomDatabaseRole Removes one custom role from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. 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-deletecustomdatabaserole. diff --git a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt index 42f67c730f..b7b8362ad3 100644 --- a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt @@ -14,6 +14,9 @@ atlas api customDatabaseRoles getCustomDatabaseRole Returns one custom role for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getcustomdatabaserole. diff --git a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt index 15fa6ff7f1..ec61b59614 100644 --- a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt +++ b/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt @@ -14,6 +14,9 @@ atlas api customDatabaseRoles listCustomDatabaseRoles Returns all custom roles for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listcustomdatabaseroles. diff --git a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt index aa06bb1269..dc1194c548 100644 --- a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt @@ -14,6 +14,9 @@ atlas api customDatabaseRoles updateCustomDatabaseRole Updates one custom role in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. 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-updatecustomdatabaserole. diff --git a/docs/command/atlas-api-customDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles.txt index 8dd6fc3d7a..bde7167f56 100644 --- a/docs/command/atlas-api-customDatabaseRoles.txt +++ b/docs/command/atlas-api-customDatabaseRoles.txt @@ -14,6 +14,9 @@ atlas api customDatabaseRoles Returns, adds, edits, and removes custom database user privilege roles. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. You define custom roles at the project level, for all clusters in the project. This resource supports a subset of MongoDB privilege actions. You can create a subset of custom role actions. To create a wider list of custom role actions, use the MongoDB Cloud user interface. Custom roles must include actions that all project's clusters support, and that are compatible with each MongoDB version that your project's clusters use. For example, if your project has MongoDB 4.2 clusters, you can't create custom roles that use actions introduced in MongoDB 4.4. Options diff --git a/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt index 22b5df0d7e..bbec12e29e 100644 --- a/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt @@ -14,6 +14,9 @@ atlas api dataFederation createDataFederationPrivateEndpoint Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. diff --git a/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt index f52ab14589..4ed92fc995 100644 --- a/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt @@ -14,6 +14,9 @@ atlas api dataFederation createFederatedDatabase Creates one federated database instance in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. 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-createfederateddatabase. diff --git a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt b/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt index 15482cb404..cd6d8a0f17 100644 --- a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt @@ -14,6 +14,9 @@ atlas api dataFederation createOneDataFederationQueryLimit Creates or updates one query limit for one federated database instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-createonedatafederationquerylimit. diff --git a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt index 0526111869..d74508b962 100644 --- a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt @@ -14,6 +14,9 @@ atlas api dataFederation deleteDataFederationPrivateEndpoint Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-deletedatafederationprivateendpoint. diff --git a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt index 430a71cf6a..35bdbe08b9 100644 --- a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt @@ -14,6 +14,9 @@ atlas api dataFederation deleteFederatedDatabase Removes one federated database instance from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. 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-deletefederateddatabase. diff --git a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt b/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt index aeae55a265..24e871e232 100644 --- a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt @@ -14,6 +14,9 @@ atlas api dataFederation deleteOneDataFederationInstanceQueryLimit Deletes one query limit for one federated database instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-deleteonedatafederationinstancequerylimit. diff --git a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt b/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt index e297865998..483c4d5b2c 100644 --- a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt +++ b/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt @@ -14,6 +14,9 @@ atlas api dataFederation downloadFederatedDatabaseQueryLogs Downloads the query logs for the specified federated database instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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". 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-downloadfederateddatabasequerylogs. diff --git a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt index 392ac58858..2f9e802788 100644 --- a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt @@ -14,6 +14,9 @@ atlas api dataFederation getDataFederationPrivateEndpoint Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. 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-getdatafederationprivateendpoint. diff --git a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt index 4c9a192848..975d6750c7 100644 --- a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt @@ -14,6 +14,9 @@ atlas api dataFederation getFederatedDatabase Returns the details of one federated database instance within the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. 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-getfederateddatabase. diff --git a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt b/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt index 94ab053769..a52b373e33 100644 --- a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt +++ b/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt @@ -14,6 +14,9 @@ atlas api dataFederation listDataFederationPrivateEndpoints Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. 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-listdatafederationprivateendpoints. diff --git a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt b/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt index 90c3088257..26dde837a0 100644 --- a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt +++ b/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt @@ -14,6 +14,9 @@ atlas api dataFederation listFederatedDatabases Returns the details of all federated database instances in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only or higher role. 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-listfederateddatabases. diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt index b81a6a461f..95a3e670c9 100644 --- a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt @@ -14,6 +14,9 @@ atlas api dataFederation returnFederatedDatabaseQueryLimit Returns the details of one query limit for the specified federated database instance in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-returnfederateddatabasequerylimit. diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt index 8589a166a2..650350e174 100644 --- a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt +++ b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt @@ -14,6 +14,9 @@ atlas api dataFederation returnFederatedDatabaseQueryLimits Returns query limits for a federated databases instance in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-returnfederateddatabasequerylimits. diff --git a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt index 6dcf586f6d..2a52b808c6 100644 --- a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt @@ -14,6 +14,9 @@ atlas api dataFederation updateFederatedDatabase Updates the details of one federated database instance in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner or higher role. 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-updatefederateddatabase. diff --git a/docs/command/atlas-api-dataFederation.txt b/docs/command/atlas-api-dataFederation.txt index ec96ccbd6a..fb32dd60ce 100644 --- a/docs/command/atlas-api-dataFederation.txt +++ b/docs/command/atlas-api-dataFederation.txt @@ -14,6 +14,9 @@ atlas api dataFederation Returns, adds, edits, and removes Federated Database Instances. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This resource requires your project ID. Changes to federated database instance configurations can affect costs. Options diff --git a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt index 3c64148622..3f6983ce8b 100644 --- a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt @@ -14,6 +14,9 @@ atlas api databaseUsers createDatabaseUser Creates one database user in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This MongoDB Cloud supports a maximum of 100 database users per project. If you require more than 100 database users on a project, contact Support. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. 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-createdatabaseuser. diff --git a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt index 41ec0ced3e..2d3a01065c 100644 --- a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt @@ -14,6 +14,9 @@ atlas api databaseUsers deleteDatabaseUser Removes one database user from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. 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-deletedatabaseuser. diff --git a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt index 9db6782719..c73c8a41ae 100644 --- a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt @@ -14,6 +14,9 @@ atlas api databaseUsers getDatabaseUser Returns one database user that belong to the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getdatabaseuser. diff --git a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt index f9f2460d0d..fdaa742090 100644 --- a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt +++ b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt @@ -14,6 +14,9 @@ atlas api databaseUsers listDatabaseUsers Returns all database users that belong to the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listdatabaseusers. diff --git a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt index 561d8020b4..9849f1ed7c 100644 --- a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt @@ -14,6 +14,9 @@ atlas api databaseUsers updateDatabaseUser Updates one database user that belongs to the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. 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-updatedatabaseuser. diff --git a/docs/command/atlas-api-databaseUsers.txt b/docs/command/atlas-api-databaseUsers.txt index 9c0ff4fef9..bb842fd0e6 100644 --- a/docs/command/atlas-api-databaseUsers.txt +++ b/docs/command/atlas-api-databaseUsers.txt @@ -14,6 +14,11 @@ atlas api databaseUsers Returns, adds, edits, and removes database users. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt index c1e3d44d0c..415704f94c 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt @@ -14,6 +14,9 @@ atlas api encryptionAtRestUsingCustomerKeyManagement createEncryptionAtRestPriva Creates a private endpoint in the specified region for encryption at rest using customer key management. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-createencryptionatrestprivateendpoint. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt index 27f9e47585..305d58ee67 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt @@ -14,6 +14,9 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRest Returns the configuration for encryption at rest using the keys you manage through your cloud provider. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting Service Account or API Key to have the Project Owner role. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt index 2d75d01bd3..f02000dfe0 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt @@ -14,6 +14,9 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateE Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getencryptionatrestprivateendpoint. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt index 0a6b19820d..7bee64ffc2 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt @@ -14,6 +14,9 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateE Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getencryptionatrestprivateendpointsforcloudprovider. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt index 872a73df8d..e3a03b7310 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt @@ -14,6 +14,9 @@ atlas api encryptionAtRestUsingCustomerKeyManagement requestEncryptionAtRestPriv Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-requestencryptionatrestprivateendpointdeletion. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt index fe9378b280..70a798ebd9 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt @@ -14,6 +14,9 @@ atlas api encryptionAtRestUsingCustomerKeyManagement updateEncryptionAtRest Updates the configuration for encryption at rest using the keys you manage through your cloud provider. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting Service Account or API Key to have the Project Owner role. This feature isn't available for M0 free clusters, M2, M5, or serverless clusters. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt index 389cb1e029..5cd3af2acb 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt @@ -14,6 +14,9 @@ atlas api encryptionAtRestUsingCustomerKeyManagement Returns and edits the Encryption at Rest using Customer Key Management configuration. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + MongoDB Cloud encrypts all storage whether or not you use your own key management. Options diff --git a/docs/command/atlas-api-events-getOrganizationEvent.txt b/docs/command/atlas-api-events-getOrganizationEvent.txt index c7687f92b8..9966649f3f 100644 --- a/docs/command/atlas-api-events-getOrganizationEvent.txt +++ b/docs/command/atlas-api-events-getOrganizationEvent.txt @@ -14,6 +14,9 @@ atlas api events getOrganizationEvent Returns one event for the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. Use the Return Events from One Organization endpoint to retrieve all events to which the authenticated user has access. diff --git a/docs/command/atlas-api-events-getProjectEvent.txt b/docs/command/atlas-api-events-getProjectEvent.txt index 275067ef4e..e61fb6cc2c 100644 --- a/docs/command/atlas-api-events-getProjectEvent.txt +++ b/docs/command/atlas-api-events-getProjectEvent.txt @@ -14,6 +14,9 @@ atlas api events getProjectEvent Returns one event for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return Events from One Project endpoint to retrieve all events to which the authenticated user has access. diff --git a/docs/command/atlas-api-events-listEventTypes.txt b/docs/command/atlas-api-events-listEventTypes.txt index 04b6446579..dd69cdbf48 100644 --- a/docs/command/atlas-api-events-listEventTypes.txt +++ b/docs/command/atlas-api-events-listEventTypes.txt @@ -14,6 +14,9 @@ atlas api events listEventTypes Returns a list of all event types, along with a description and additional metadata about each event. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-listeventtypes. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-events-listOrganizationEvents.txt b/docs/command/atlas-api-events-listOrganizationEvents.txt index 3fddb0278a..d4f010cf4d 100644 --- a/docs/command/atlas-api-events-listOrganizationEvents.txt +++ b/docs/command/atlas-api-events-listOrganizationEvents.txt @@ -14,6 +14,9 @@ atlas api events listOrganizationEvents Returns events for the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-events-listProjectEvents.txt b/docs/command/atlas-api-events-listProjectEvents.txt index 6ff969bede..f52ab0fe30 100644 --- a/docs/command/atlas-api-events-listProjectEvents.txt +++ b/docs/command/atlas-api-events-listProjectEvents.txt @@ -14,6 +14,9 @@ atlas api events listProjectEvents Returns events for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-events.txt b/docs/command/atlas-api-events.txt index 20dea625ea..585cbd208b 100644 --- a/docs/command/atlas-api-events.txt +++ b/docs/command/atlas-api-events.txt @@ -14,6 +14,9 @@ atlas api events Returns events. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This collection remains under revision and may change. Options diff --git a/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt index 22e8fa3813..595cb1d45d 100644 --- a/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt @@ -14,6 +14,9 @@ atlas api federatedAuthentication createIdentityProvider Creates one identity provider within the specified federation. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt index 736510bf86..266226208d 100644 --- a/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt @@ -14,6 +14,9 @@ atlas api federatedAuthentication createRoleMapping Adds one role mapping to the specified organization in the specified federation. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. 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-createrolemapping. diff --git a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt b/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt index 79dda14637..8a17a7eb8f 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt @@ -14,6 +14,9 @@ atlas api federatedAuthentication deleteFederationApp Deletes the federation settings instance and all associated data, including identity providers and domains. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the last remaining connected organization. Note: requests to this resource will fail if there is more than one connected organization in the federation. 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-deletefederationapp. diff --git a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt index a0a94f3672..fe5b8bed38 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt @@ -14,6 +14,9 @@ atlas api federatedAuthentication deleteIdentityProvider Deletes one identity provider in the specified federation. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt index e0e3781328..17e3e4e2e6 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt @@ -14,6 +14,9 @@ atlas api federatedAuthentication deleteRoleMapping Removes one role mapping in the specified organization from the specified federation. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. 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-deleterolemapping. diff --git a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt index 248bac6c2a..19af52891a 100644 --- a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt @@ -14,6 +14,9 @@ atlas api federatedAuthentication getConnectedOrgConfig Returns the specified connected org config from the specified federation. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. 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-getconnectedorgconfig. diff --git a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt index d0fcda9943..561d0d40e3 100644 --- a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt +++ b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt @@ -14,6 +14,9 @@ atlas api federatedAuthentication getFederationSettings Returns information about the federation settings for the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. 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-getfederationsettings. diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt index 729cb4da6d..33f2d44ecb 100644 --- a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt @@ -14,6 +14,9 @@ atlas api federatedAuthentication getIdentityProvider Returns one identity provider in the specified federation by the identity provider's id. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. 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-getidentityprovider. diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt index 4c9e36acec..af0bb6473b 100644 --- a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt +++ b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt @@ -14,6 +14,9 @@ atlas api federatedAuthentication getIdentityProviderMetadata Returns the metadata of one identity provider in the specified federation. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. 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-getidentityprovidermetadata. diff --git a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt index a63f584d15..50e6c13e29 100644 --- a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt @@ -14,6 +14,9 @@ atlas api federatedAuthentication getRoleMapping Returns one role mapping from the specified organization in the specified federation. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. 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-getrolemapping. diff --git a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt index 6b7124e0a8..bf8f8c4e64 100644 --- a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt +++ b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt @@ -14,6 +14,9 @@ atlas api federatedAuthentication listConnectedOrgConfigs Returns all connected org configs in the specified federation. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected orgs. 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-listconnectedorgconfigs. diff --git a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt index 93c8c423e3..d2f7a79f69 100644 --- a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt +++ b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt @@ -14,6 +14,9 @@ atlas api federatedAuthentication listIdentityProviders Returns all identity providers with the provided protocol and type in the specified federation. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. 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-listidentityproviders. diff --git a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt index e0b38af5a0..5eabe9cb59 100644 --- a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt +++ b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt @@ -14,6 +14,9 @@ atlas api federatedAuthentication listRoleMappings Returns all role mappings from the specified organization in the specified federation. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. 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-listrolemappings. diff --git a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt index bf55a85989..4548d02fe2 100644 --- a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt @@ -14,6 +14,9 @@ atlas api federatedAuthentication removeConnectedOrgConfig Removes one connected organization configuration from the specified federation. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation. 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-removeconnectedorgconfig. diff --git a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt index 44d54e2001..e43d0f9944 100644 --- a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt @@ -14,6 +14,9 @@ atlas api federatedAuthentication revokeJwksFromIdentityProvider Revokes the JWKS tokens from the requested OIDC identity provider. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt index 8bd3f581bb..d1646aa411 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt @@ -14,6 +14,9 @@ atlas api federatedAuthentication updateConnectedOrgConfig Updates one connected organization configuration from the specified federation. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt index 89064ec6ec..a32858f2b8 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt @@ -14,6 +14,9 @@ atlas api federatedAuthentication updateIdentityProvider Updates one identity provider in the specified federation. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt index 7374c4b886..dc05c7020d 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt @@ -14,6 +14,9 @@ atlas api federatedAuthentication updateRoleMapping Updates one role mapping in the specified organization in the specified federation. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. 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-updaterolemapping. diff --git a/docs/command/atlas-api-federatedAuthentication.txt b/docs/command/atlas-api-federatedAuthentication.txt index adb0fbbbec..746fc536eb 100644 --- a/docs/command/atlas-api-federatedAuthentication.txt +++ b/docs/command/atlas-api-federatedAuthentication.txt @@ -14,6 +14,11 @@ atlas api federatedAuthentication Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-flexClusters-createFlexCluster.txt b/docs/command/atlas-api-flexClusters-createFlexCluster.txt index fc079bf9a4..0e9d1655ac 100644 --- a/docs/command/atlas-api-flexClusters-createFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-createFlexCluster.txt @@ -14,6 +14,9 @@ atlas api flexClusters createFlexCluster Creates one flex cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-createflexcluster. diff --git a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt index 4480658c5b..40c4735cce 100644 --- a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt @@ -14,6 +14,9 @@ atlas api flexClusters deleteFlexCluster Removes one flex cluster from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The flex cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-deleteflexcluster. diff --git a/docs/command/atlas-api-flexClusters-getFlexCluster.txt b/docs/command/atlas-api-flexClusters-getFlexCluster.txt index 63f4b86d65..f0af69991a 100644 --- a/docs/command/atlas-api-flexClusters-getFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-getFlexCluster.txt @@ -14,6 +14,9 @@ atlas api flexClusters getFlexCluster Returns details for one flex cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getflexcluster. diff --git a/docs/command/atlas-api-flexClusters-listFlexClusters.txt b/docs/command/atlas-api-flexClusters-listFlexClusters.txt index b0d82a9815..b58ceba0fc 100644 --- a/docs/command/atlas-api-flexClusters-listFlexClusters.txt +++ b/docs/command/atlas-api-flexClusters-listFlexClusters.txt @@ -14,6 +14,9 @@ atlas api flexClusters listFlexClusters Returns details for all flex clusters in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listflexclusters. diff --git a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt index f1b8d1f937..a0041fe330 100644 --- a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt @@ -14,6 +14,9 @@ atlas api flexClusters updateFlexCluster Updates one flex cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-updateflexcluster. diff --git a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt b/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt index 466f04382b..3af944c292 100644 --- a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt @@ -14,6 +14,9 @@ atlas api flexClusters upgradeFlexCluster Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. 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-upgradeflexcluster. diff --git a/docs/command/atlas-api-flexClusters.txt b/docs/command/atlas-api-flexClusters.txt index 2ecadeb598..3c6accbf51 100644 --- a/docs/command/atlas-api-flexClusters.txt +++ b/docs/command/atlas-api-flexClusters.txt @@ -14,6 +14,11 @@ atlas api flexClusters Returns, adds, edits, and removes flex clusters. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt index ba022d3167..7d09b7b9a2 100644 --- a/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt +++ b/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt @@ -14,6 +14,9 @@ atlas api flexRestoreJobs createFlexBackupRestoreJob Restores one snapshot of one flex cluster from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-createflexbackuprestorejob. diff --git a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt index 6ec3a2ced7..3e181d8edf 100644 --- a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt +++ b/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt @@ -14,6 +14,9 @@ atlas api flexRestoreJobs getFlexBackupRestoreJob Returns one restore job for one flex cluster from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-getflexbackuprestorejob. diff --git a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt index 0990c2b663..7310c358cf 100644 --- a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt +++ b/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt @@ -14,6 +14,9 @@ atlas api flexRestoreJobs listFlexBackupRestoreJobs Returns all restore jobs for one flex cluster from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-listflexbackuprestorejobs. diff --git a/docs/command/atlas-api-flexRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs.txt index 6af27fc245..54ed0f2b00 100644 --- a/docs/command/atlas-api-flexRestoreJobs.txt +++ b/docs/command/atlas-api-flexRestoreJobs.txt @@ -14,6 +14,11 @@ atlas api flexRestoreJobs Returns and adds restore jobs for flex database deployments. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt b/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt index 11641c1edd..799d8fac9e 100644 --- a/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt +++ b/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt @@ -14,6 +14,9 @@ atlas api flexSnapshots downloadFlexBackup Requests one snapshot for the specified flex cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This 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-downloadflexbackup. diff --git a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt b/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt index 033e8bc219..db0de9901c 100644 --- a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt +++ b/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt @@ -14,6 +14,9 @@ atlas api flexSnapshots getFlexBackup Returns one snapshot of one flex cluster from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getflexbackup. diff --git a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt b/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt index 4e6b47fe25..476209ca12 100644 --- a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt +++ b/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt @@ -14,6 +14,9 @@ atlas api flexSnapshots listFlexBackups Returns all snapshots of one flex cluster from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listflexbackups. diff --git a/docs/command/atlas-api-flexSnapshots.txt b/docs/command/atlas-api-flexSnapshots.txt index 7c6cf6a961..1044e7d0af 100644 --- a/docs/command/atlas-api-flexSnapshots.txt +++ b/docs/command/atlas-api-flexSnapshots.txt @@ -14,6 +14,11 @@ atlas api flexSnapshots Returns and requests to download flex database deployment snapshots. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt b/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt index 3152f6af67..560e2106c8 100644 --- a/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt +++ b/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt @@ -14,6 +14,9 @@ atlas api globalClusters createCustomZoneMapping Creates one custom zone mapping for the specified global cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-createcustomzonemapping. diff --git a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt index f7d23b4988..c686f3d6a6 100644 --- a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt @@ -14,6 +14,9 @@ atlas api globalClusters createManagedNamespace Creates one managed namespace within the specified global cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. 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-createmanagednamespace. diff --git a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt b/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt index 88735e5cef..e78801e5e2 100644 --- a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt +++ b/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt @@ -14,6 +14,9 @@ atlas api globalClusters deleteAllCustomZoneMappings Removes all custom zone mappings for the specified global cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-deleteallcustomzonemappings. diff --git a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt b/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt index c317313771..193fb71d55 100644 --- a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt @@ -14,6 +14,9 @@ atlas api globalClusters deleteManagedNamespace Removes one managed namespace within the specified global cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + A managed namespace identifies a collection using the database name, the dot separator, and the collection name. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. 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-deletemanagednamespace. diff --git a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt b/docs/command/atlas-api-globalClusters-getManagedNamespace.txt index 1c19076922..48afcf3bc4 100644 --- a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-getManagedNamespace.txt @@ -14,6 +14,9 @@ atlas api globalClusters getManagedNamespace Returns one managed namespace within the specified global cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getmanagednamespace. diff --git a/docs/command/atlas-api-globalClusters.txt b/docs/command/atlas-api-globalClusters.txt index 8db86aa63c..7497563288 100644 --- a/docs/command/atlas-api-globalClusters.txt +++ b/docs/command/atlas-api-globalClusters.txt @@ -14,6 +14,9 @@ atlas api globalClusters Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Each collection in a Global Cluster is associated with a managed namespace. When you create a managed namespace for a Global Cluster, MongoDB Cloud creates an empty collection for that namespace. Creating a managed namespace doesn't populate a collection with data. Similarly, deleting a managed namespace doesn't delete the associated collection. MongoDB Cloud shards the empty collection using the required location field and a custom shard key. For example, if your custom shard key is city, the compound shard key is location, city. Each Global Cluster is also associated with one or more Global Writes Zones. When a user creates a Global Cluster, MongoDB Cloud automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. For example, a use case might require mapping a location code to a geographically distant zone. Administrators can manage custom zone mappings with the APIs below and the Global Cluster Configuration pane when you create or modify your Global Cluster. diff --git a/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt b/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt index f04623c086..1fa44e7a9d 100644 --- a/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt +++ b/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt @@ -14,6 +14,9 @@ atlas api invoices createCostExplorerQueryProcess Creates a query process within the Cost Explorer for the given parameters. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + A token is returned that can be used to poll the status of the query and eventually retrieve the results. 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-createcostexplorerqueryprocess. diff --git a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt b/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt index ff57bcacd5..656b16a899 100644 --- a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt +++ b/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt @@ -14,6 +14,9 @@ atlas api invoices downloadInvoiceCsv Returns one invoice that MongoDB issued to the specified organization in CSV format. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting Service Account or API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role. To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. diff --git a/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt b/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt index 9ac686490c..d3e72c9634 100644 --- a/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt +++ b/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt @@ -14,6 +14,9 @@ atlas api invoices getCostExplorerQueryProcess Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data. 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-getcostexplorerqueryprocess. diff --git a/docs/command/atlas-api-invoices-getInvoice.txt b/docs/command/atlas-api-invoices-getInvoice.txt index de99de0b2a..5808c3bf53 100644 --- a/docs/command/atlas-api-invoices-getInvoice.txt +++ b/docs/command/atlas-api-invoices-getInvoice.txt @@ -14,6 +14,9 @@ atlas api invoices getInvoice Returns one invoice that MongoDB issued to the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner role. To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. diff --git a/docs/command/atlas-api-invoices-listInvoices.txt b/docs/command/atlas-api-invoices-listInvoices.txt index 56f500099e..1292a08c89 100644 --- a/docs/command/atlas-api-invoices-listInvoices.txt +++ b/docs/command/atlas-api-invoices-listInvoices.txt @@ -14,6 +14,9 @@ atlas api invoices listInvoices Returns all invoices that MongoDB issued to the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This list includes all invoices regardless of invoice status. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner role. To compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula totalBilledCents * unitPrice + salesTax - startingBalanceCents. diff --git a/docs/command/atlas-api-invoices-listPendingInvoices.txt b/docs/command/atlas-api-invoices-listPendingInvoices.txt index c6ced7a5e1..e18c5b6357 100644 --- a/docs/command/atlas-api-invoices-listPendingInvoices.txt +++ b/docs/command/atlas-api-invoices-listPendingInvoices.txt @@ -14,6 +14,9 @@ atlas api invoices listPendingInvoices Returns all invoices accruing charges for the current billing cycle for the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. 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-listpendinginvoices. diff --git a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt b/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt index c02a954553..9ca4062ea3 100644 --- a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt +++ b/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt @@ -14,6 +14,9 @@ atlas api invoices queryLineItemsFromSingleInvoice Query the lineItems of the specified invoice and return the result JSON. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + A unique 24-hexadecimal digit string identifies the invoice. 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-querylineitemsfromsingleinvoice. diff --git a/docs/command/atlas-api-invoices.txt b/docs/command/atlas-api-invoices.txt index 85b96b9aa9..7adbf9fb33 100644 --- a/docs/command/atlas-api-invoices.txt +++ b/docs/command/atlas-api-invoices.txt @@ -14,6 +14,11 @@ atlas api invoices Returns invoices. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt index d349c3bb3b..4260d96bce 100644 --- a/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt @@ -14,6 +14,9 @@ atlas api ldapConfiguration deleteLdapConfiguration Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-deleteldapconfiguration. diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt index 472da8c8ea..7792f6e1bf 100644 --- a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt @@ -14,6 +14,9 @@ atlas api ldapConfiguration getLdapConfiguration Returns the current LDAP configuration for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-getldapconfiguration. diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt index 2f427141b2..70ac260409 100644 --- a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt +++ b/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt @@ -14,6 +14,9 @@ atlas api ldapConfiguration getLdapConfigurationStatus Returns the status of one request to verify one LDAP configuration for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-getldapconfigurationstatus. diff --git a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt index 345be8a891..304f8a35e5 100644 --- a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt @@ -14,6 +14,9 @@ atlas api ldapConfiguration saveLdapConfiguration Edits the LDAP configuration for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt index 85ddd72b84..f203fc68f3 100644 --- a/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt @@ -14,6 +14,9 @@ atlas api ldapConfiguration verifyLdapConfiguration Verifies the LDAP configuration for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-verifyldapconfiguration. diff --git a/docs/command/atlas-api-ldapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration.txt index dc6199e1bb..28d59f6727 100644 --- a/docs/command/atlas-api-ldapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration.txt @@ -14,6 +14,9 @@ atlas api ldapConfiguration Returns, edits, verifies, and removes LDAP configurations. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + An LDAP configuration defines settings for MongoDB Cloud to connect to your LDAP server over TLS for user authentication and authorization. Your LDAP server must be visible to the internet or connected to your MongoDB Cloud cluster with VPC Peering. Also, your LDAP server must use TLS. You must have the MongoDB Cloud admin user privilege to use these endpoints. Also, to configure user authentication and authorization with LDAPS, your cluster must run MongoDB 3.6 or higher. Groups for which you have configured LDAPS can't create a cluster using a version of MongoDB 3.6 or lower. Options diff --git a/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt b/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt index 3dc8ca3f44..b765e9cb84 100644 --- a/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt +++ b/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt @@ -14,6 +14,9 @@ atlas api legacyBackup createLegacyBackupRestoreJob Restores one legacy backup for one cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying delivery.methodName of AUTOMATED_RESTORE in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. 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-createlegacybackuprestorejob. diff --git a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt index c54c4e6fbf..71e24a0138 100644 --- a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt +++ b/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt @@ -14,6 +14,9 @@ atlas api legacyBackup deleteLegacySnapshot Removes one legacy backup snapshot for one cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This 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-deletelegacysnapshot. diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt index b4c841ea66..14b6a04cd8 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt @@ -14,6 +14,9 @@ atlas api legacyBackup getLegacyBackupCheckpoint Returns one legacy backup checkpoint for one cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getlegacybackupcheckpoint. diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt index 786f2621e3..9c73a82f07 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt @@ -14,6 +14,9 @@ atlas api legacyBackup getLegacyBackupRestoreJob Returns one legacy backup restore job for one cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt index 7eaccd41c5..f2e456cc63 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt @@ -14,6 +14,9 @@ atlas api legacyBackup getLegacySnapshot Returns one legacy backup snapshot for one cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. 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-getlegacysnapshot. diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt index f4931d344d..1d15534ea1 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt @@ -14,6 +14,9 @@ atlas api legacyBackup getLegacySnapshotSchedule Returns the snapshot schedule for one cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt index 1c6094ee00..26caa02328 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt @@ -14,6 +14,9 @@ atlas api legacyBackup listLegacyBackupCheckpoints Returns all legacy backup checkpoints for one cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listlegacybackupcheckpoints. diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt index cfa9b38345..c545d4f270 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt @@ -14,6 +14,9 @@ atlas api legacyBackup listLegacyBackupRestoreJobs Returns all legacy backup restore jobs for one cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt b/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt index 4aec03c82f..d268c6fcf7 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt @@ -14,6 +14,9 @@ atlas api legacyBackup listLegacySnapshots Returns all legacy backup snapshots for one cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. 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-listlegacysnapshots. diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt index f7fd998ec1..14da7bb1bf 100644 --- a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt +++ b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt @@ -14,6 +14,9 @@ atlas api legacyBackup updateLegacySnapshotRetention Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This 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-updatelegacysnapshotretention. diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt index 9d8d6a175f..7090781ada 100644 --- a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt +++ b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt @@ -14,6 +14,9 @@ atlas api legacyBackup updateLegacySnapshotSchedule Updates the snapshot schedule for one cluster in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-legacyBackup.txt b/docs/command/atlas-api-legacyBackup.txt index 36acd1d547..bea5da224f 100644 --- a/docs/command/atlas-api-legacyBackup.txt +++ b/docs/command/atlas-api-legacyBackup.txt @@ -14,6 +14,11 @@ atlas api legacyBackup Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt index f511bf8153..ede4623302 100644 --- a/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt @@ -14,6 +14,9 @@ atlas api maintenanceWindows deferMaintenanceWindow Defers the maintenance window for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-defermaintenancewindow. diff --git a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt index c33c9ecedf..309cb1c4ad 100644 --- a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt @@ -14,6 +14,9 @@ atlas api maintenanceWindows getMaintenanceWindow Returns the maintenance window for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-getmaintenancewindow. diff --git a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt index 19f29e95cd..a155c19bf0 100644 --- a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt @@ -14,6 +14,9 @@ atlas api maintenanceWindows resetMaintenanceWindow Resets the maintenance window for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-resetmaintenancewindow. diff --git a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt index e255bddebb..3193dae66c 100644 --- a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt +++ b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt @@ -14,6 +14,9 @@ atlas api maintenanceWindows toggleMaintenanceAutoDefer Toggles automatic deferral of the maintenance window for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-togglemaintenanceautodefer. diff --git a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt index 8595304029..b96356c534 100644 --- a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt @@ -14,6 +14,9 @@ atlas api maintenanceWindows updateMaintenanceWindow Updates the maintenance window for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. Updating the maintenance window will reset any maintenance deferrals for this project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-updatemaintenancewindow. diff --git a/docs/command/atlas-api-maintenanceWindows.txt b/docs/command/atlas-api-maintenanceWindows.txt index e8b8e09988..2ab28d4117 100644 --- a/docs/command/atlas-api-maintenanceWindows.txt +++ b/docs/command/atlas-api-maintenanceWindows.txt @@ -14,6 +14,9 @@ atlas api maintenanceWindows Returns, edits, and removes maintenance windows. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. You can defer a scheduled maintenance event for a project up to two times. Deferred maintenance events occur during your preferred maintenance window exactly one week after the previously scheduled date and time. Options diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt index 9f9cfedef3..a2302c8e64 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers addOrganizationRole Adds one organization-level role to the MongoDB Cloud user. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt index 038cc61741..1c132c4d41 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers addProjectRole Adds one project-level role to the MongoDB Cloud user. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can add a role to an active user or a user that has been invited to join the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt index 8f1db24979..8e2f94749e 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers addProjectUser Adds one MongoDB Cloud user to one project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt b/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt index fff8a31ab6..3bd20d72a4 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers addUserToTeam Adds one MongoDB Cloud user to one team. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can add an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt index 629e3709ea..782d21b609 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers createOrganizationUser Invites one new or existing MongoDB Cloud user to join the organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt index ba298d852f..5d44429c99 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers createUser Creates one MongoDB Cloud user account. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt index 5280087404..dd7f9897bd 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers getOrganizationUser Returns information about the specified MongoDB Cloud user within the context of the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt index 11983f6356..50573682de 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers getProjectUser Returns information about the specified MongoDB Cloud user within the context of the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt index 1684fbf469..d25647ec2c 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers getUser Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can't use this endpoint to return information on an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. You can always retrieve your own user account. If you are the owner of a MongoDB Cloud organization or project, you can also retrieve the user profile for any user with membership in that organization or project. To use this resource, the requesting Service Account or API Key can have any role. 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-getuser. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt index 4469969009..a9534a84a0 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers getUserByUsername Returns the details for one MongoDB Cloud user account with the specified username. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can't use this endpoint to return information about an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. To use this resource, the requesting Service Account or API Key can have any role. 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-getuserbyusername. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt index 4361eea7a7..767837e9b3 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers listOrganizationUsers Returns details about the pending and active MongoDB Cloud users associated with the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt index 664669e28f..0f09791a7c 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers listProjectUsers Returns details about the pending and active MongoDB Cloud users associated with the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt index 3859ae4d17..1346f92e95 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers listTeamUsers Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt index 9cf2d8e96d..96ae2c4cf4 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers removeOrganizationRole Removes one organization-level role from the MongoDB Cloud user. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt index aa5e205d06..147edd4bdd 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers removeOrganizationUser Removes one MongoDB Cloud user in the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt index 3161651545..829638530f 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers removeProjectRole Removes one project-level role from the MongoDB Cloud user. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can remove a role from an active user or a user that has been invited to join the project. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt index f80e896ed2..17d78cb0fc 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers removeProjectUser Removes one MongoDB Cloud user from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt index dd580f0c91..f484f50ec3 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers removeUserFromTeam Removes one MongoDB Cloud user from one team. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt index cf94e5ae7e..09f583116b 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt @@ -14,6 +14,9 @@ atlas api mongoDbCloudUsers updateOrganizationUser Updates one MongoDB Cloud user in the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers.txt index 33a954365f..3e731b7a0c 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers.txt @@ -14,6 +14,11 @@ atlas api mongoDbCloudUsers Returns, adds, and edits MongoDB Cloud users. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt b/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt index 044f893a5c..ea6ea8aefe 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt @@ -14,6 +14,9 @@ atlas api monitoringAndLogs getAtlasProcess Returns the processes for the specified host for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getatlasprocess. diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt index 63dff12d7b..ce79935833 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt @@ -14,6 +14,9 @@ atlas api monitoringAndLogs getDatabase Returns one database running on the specified host for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getdatabase. diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt index 23a443aa29..1bc1ec14d1 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt @@ -14,6 +14,9 @@ atlas api monitoringAndLogs getDatabaseMeasurements Returns the measurements of one database for the specified host for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Returns the database's on-disk storage space based on the MongoDB dbStats command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getdatabasemeasurements. diff --git a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt index a1b90cacd6..08378b57fd 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt @@ -14,6 +14,9 @@ atlas api monitoringAndLogs getDiskMeasurements Returns the measurements of one disk or partition for the specified host for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Returned value can be one of the following: diff --git a/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt b/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt index 2b5a18f9db..dd34f37e26 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt @@ -14,6 +14,9 @@ atlas api monitoringAndLogs getHostLogs Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes. Logs are stored in chunks approximately five minutes in length, but this duration may vary. If you poll the API for log files, we recommend polling every five minutes even though consecutive polls could contain some overlapping logs. This feature isn't available for M0 free clusters, M2, M5, flex, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". 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-gethostlogs. diff --git a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt index 6f07417951..4106f42a7a 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt @@ -14,6 +14,9 @@ atlas api monitoringAndLogs getHostMeasurements Returns disk, partition, or host measurements per process for the specified host for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Returned value can be one of the following: diff --git a/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt b/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt index 8c6f1aef7e..d15958b30f 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt @@ -14,6 +14,9 @@ atlas api monitoringAndLogs getIndexMetrics Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You must have the Project Read Only or higher role to view the Atlas Search metric types. 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-getindexmetrics. diff --git a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt index caf2c36bfb..94dda4970d 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt @@ -14,6 +14,9 @@ atlas api monitoringAndLogs getMeasurements Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You must have the Project Read Only or higher role to view the Atlas Search metric types. 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-getmeasurements. diff --git a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt b/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt index 717c511208..c7a275e69d 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt @@ -14,6 +14,9 @@ atlas api monitoringAndLogs listAtlasProcesses Returns details of all processes for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + A MongoDB process can be either a mongod or mongos. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listatlasprocesses. diff --git a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt index 394d3817e2..e214ba60eb 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt @@ -14,6 +14,9 @@ atlas api monitoringAndLogs listDatabases Returns the list of databases running on the specified host for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-listdatabases. diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt index 6f17bfd587..9acd28eda3 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt @@ -14,6 +14,9 @@ atlas api monitoringAndLogs listDiskMeasurements Returns measurement details for one disk or partition for the specified host for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listdiskmeasurements. diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt index 05447b9b9c..fc46f9b956 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt @@ -14,6 +14,9 @@ atlas api monitoringAndLogs listDiskPartitions Returns the list of disks or partitions for the specified host for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listdiskpartitions. diff --git a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt b/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt index 953676b5fe..67b592ec2e 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt @@ -14,6 +14,9 @@ atlas api monitoringAndLogs listIndexMetrics Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-listindexmetrics. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt b/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt index f1ac8c3c7d..980662747c 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt @@ -14,6 +14,9 @@ atlas api monitoringAndLogs listMetricTypes Returns all Atlas Search metric types available for one process in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You must have the Project Read Only or higher role to view the Atlas Search metric types. 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-listmetrictypes. diff --git a/docs/command/atlas-api-monitoringAndLogs.txt b/docs/command/atlas-api-monitoringAndLogs.txt index 28b7245c4c..96a7dd5613 100644 --- a/docs/command/atlas-api-monitoringAndLogs.txt +++ b/docs/command/atlas-api-monitoringAndLogs.txt @@ -14,6 +14,11 @@ atlas api monitoringAndLogs Returns database deployment monitoring and logging data. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-networkPeering-createPeeringConnection.txt b/docs/command/atlas-api-networkPeering-createPeeringConnection.txt index 847a914c95..789005917d 100644 --- a/docs/command/atlas-api-networkPeering-createPeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-createPeeringConnection.txt @@ -14,6 +14,9 @@ atlas api networkPeering createPeeringConnection Creates one new network peering connection in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. 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-createpeeringconnection. diff --git a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt b/docs/command/atlas-api-networkPeering-createPeeringContainer.txt index 084b532e72..04923795c3 100644 --- a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-createPeeringContainer.txt @@ -14,6 +14,9 @@ atlas api networkPeering createPeeringContainer Creates one new network peering container in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-createpeeringcontainer. diff --git a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt b/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt index 29b4bb97e1..9ba68e6fba 100644 --- a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt @@ -14,6 +14,9 @@ atlas api networkPeering deletePeeringConnection Removes one network peering connection in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-deletepeeringconnection. diff --git a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt b/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt index 33cdb1149e..a2e43fe7dd 100644 --- a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt @@ -14,6 +14,9 @@ atlas api networkPeering deletePeeringContainer Removes one network peering container in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-deletepeeringcontainer. diff --git a/docs/command/atlas-api-networkPeering-disablePeering.txt b/docs/command/atlas-api-networkPeering-disablePeering.txt index 144cf463ef..61f79df2ca 100644 --- a/docs/command/atlas-api-networkPeering-disablePeering.txt +++ b/docs/command/atlas-api-networkPeering-disablePeering.txt @@ -14,6 +14,9 @@ atlas api networkPeering disablePeering Disables Connect via Peering Only mode for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-disablepeering. diff --git a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt b/docs/command/atlas-api-networkPeering-getPeeringConnection.txt index a00680c44d..638d71c608 100644 --- a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-getPeeringConnection.txt @@ -14,6 +14,9 @@ atlas api networkPeering getPeeringConnection Returns details about one specified network peering connection in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getpeeringconnection. diff --git a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt b/docs/command/atlas-api-networkPeering-getPeeringContainer.txt index 3ed109d020..df88ccb1a7 100644 --- a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-getPeeringContainer.txt @@ -14,6 +14,9 @@ atlas api networkPeering getPeeringContainer Returns details about one network peering container in one specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getpeeringcontainer. diff --git a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt b/docs/command/atlas-api-networkPeering-listPeeringConnections.txt index fd4327a001..c414b0ca0d 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringConnections.txt @@ -14,6 +14,9 @@ atlas api networkPeering listPeeringConnections Returns details about all network peering connections in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listpeeringconnections. diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt b/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt index 3e95ffc7a0..748dc70674 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt @@ -14,6 +14,9 @@ atlas api networkPeering listPeeringContainerByCloudProvider Returns details about all network peering containers in the specified project for the specified cloud provider. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listpeeringcontainerbycloudprovider. diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt b/docs/command/atlas-api-networkPeering-listPeeringContainers.txt index 179cabb33e..7abddb70ae 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringContainers.txt @@ -14,6 +14,9 @@ atlas api networkPeering listPeeringContainers Returns details about all network peering containers in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listpeeringcontainers. diff --git a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt b/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt index 80ea39302c..3329de3d04 100644 --- a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt @@ -14,6 +14,9 @@ atlas api networkPeering updatePeeringConnection Updates one specified network peering connection in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-updatepeeringconnection. diff --git a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt b/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt index 8dd2751d16..bc13806cdc 100644 --- a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt @@ -14,6 +14,9 @@ atlas api networkPeering updatePeeringContainer Updates the network details and labels of one specified network peering container in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-updatepeeringcontainer. diff --git a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt b/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt index 70da472ff1..42da353132 100644 --- a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt +++ b/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt @@ -14,6 +14,9 @@ atlas api networkPeering verifyConnectViaPeeringOnlyModeForOneProject Verifies if someone set the specified project to Connect via Peering Only mode. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-verifyconnectviapeeringonlymodeforoneproject. diff --git a/docs/command/atlas-api-networkPeering.txt b/docs/command/atlas-api-networkPeering.txt index 491982631f..14cd13f8a7 100644 --- a/docs/command/atlas-api-networkPeering.txt +++ b/docs/command/atlas-api-networkPeering.txt @@ -14,6 +14,9 @@ atlas api networkPeering Returns, adds, edits, and removes network peering containers and peering connections. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + When you deploy an M10+ dedicated cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block. Options diff --git a/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt index 2f2afecb6b..788f22f19c 100644 --- a/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt @@ -14,6 +14,9 @@ atlas api onlineArchive createOnlineArchive Creates one online archive. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. 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-createonlinearchive. diff --git a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt index d474636ae0..d13c362323 100644 --- a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt @@ -14,6 +14,9 @@ atlas api onlineArchive deleteOnlineArchive Removes one online archive. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. 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-deleteonlinearchive. diff --git a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt b/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt index 1d4da952e6..d5ee67c10a 100644 --- a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt +++ b/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt @@ -14,6 +14,9 @@ atlas api onlineArchive downloadOnlineArchiveQueryLogs Downloads query logs for the specified online archive. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". 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-downloadonlinearchivequerylogs. diff --git a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt index 6dda49e2c0..2fcdba9a55 100644 --- a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt @@ -14,6 +14,9 @@ atlas api onlineArchive getOnlineArchive Returns one online archive for one cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getonlinearchive. diff --git a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt index d5ff03b093..dd2054b5cc 100644 --- a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt +++ b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt @@ -14,6 +14,9 @@ atlas api onlineArchive listOnlineArchives Returns details of all online archives. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listonlinearchives. diff --git a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt index ce09e2d608..575c07d8d9 100644 --- a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt @@ -14,6 +14,9 @@ atlas api onlineArchive updateOnlineArchive Updates, pauses, or resumes one online archive. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. 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-updateonlinearchive. diff --git a/docs/command/atlas-api-onlineArchive.txt b/docs/command/atlas-api-onlineArchive.txt index d76e4693ab..6c482167de 100644 --- a/docs/command/atlas-api-onlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive.txt @@ -14,6 +14,11 @@ atlas api onlineArchive Returns, adds, edits, or removes an online archive. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-organizations-createOrganization.txt b/docs/command/atlas-api-organizations-createOrganization.txt index f844c91a3c..87127c5ba7 100644 --- a/docs/command/atlas-api-organizations-createOrganization.txt +++ b/docs/command/atlas-api-organizations-createOrganization.txt @@ -14,6 +14,9 @@ atlas api organizations createOrganization Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. The requesting Service Account's or API Key's organization must be a paying organization. To learn more, see Configure a Paying Organization in the MongoDB Atlas documentation. 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-createorganization. diff --git a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt b/docs/command/atlas-api-organizations-createOrganizationInvitation.txt index 03122028bb..7f27f767e3 100644 --- a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-createOrganizationInvitation.txt @@ -14,6 +14,9 @@ atlas api organizations createOrganizationInvitation Invites one MongoDB Cloud user to join the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The user must accept the invitation to access information within the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-deleteOrganization.txt b/docs/command/atlas-api-organizations-deleteOrganization.txt index 460df10deb..2843acbfb6 100644 --- a/docs/command/atlas-api-organizations-deleteOrganization.txt +++ b/docs/command/atlas-api-organizations-deleteOrganization.txt @@ -14,6 +14,9 @@ atlas api organizations deleteOrganization Removes one specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + MongoDB Cloud imposes the following limits on this resource: diff --git a/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt b/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt index 7a2e73888e..7af3b8c337 100644 --- a/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt @@ -14,6 +14,9 @@ atlas api organizations deleteOrganizationInvitation Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can't cancel an invitation that the user accepted. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-getOrganization.txt b/docs/command/atlas-api-organizations-getOrganization.txt index 973eee168a..4c66edce1b 100644 --- a/docs/command/atlas-api-organizations-getOrganization.txt +++ b/docs/command/atlas-api-organizations-getOrganization.txt @@ -14,6 +14,9 @@ atlas api organizations getOrganization Returns one organization to which the requesting Service Account or API Key has access. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Member role. 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-getorganization. diff --git a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt b/docs/command/atlas-api-organizations-getOrganizationInvitation.txt index 255ed46a17..0598b5df2b 100644 --- a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-getOrganizationInvitation.txt @@ -14,6 +14,9 @@ atlas api organizations getOrganizationInvitation Returns the details of one pending invitation to the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-getOrganizationSettings.txt b/docs/command/atlas-api-organizations-getOrganizationSettings.txt index 041caf9a1e..e282c80214 100644 --- a/docs/command/atlas-api-organizations-getOrganizationSettings.txt +++ b/docs/command/atlas-api-organizations-getOrganizationSettings.txt @@ -14,6 +14,9 @@ atlas api organizations getOrganizationSettings Returns details about the specified organization's settings. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Member role. 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-getorganizationsettings. diff --git a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt index b2f3be5c4c..6cc3db893b 100644 --- a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt +++ b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt @@ -14,6 +14,9 @@ atlas api organizations listOrganizationInvitations Returns all pending invitations to the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-listOrganizationProjects.txt b/docs/command/atlas-api-organizations-listOrganizationProjects.txt index da12efea46..5bd1550f03 100644 --- a/docs/command/atlas-api-organizations-listOrganizationProjects.txt +++ b/docs/command/atlas-api-organizations-listOrganizationProjects.txt @@ -14,6 +14,9 @@ atlas api organizations listOrganizationProjects Returns multiple projects in the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Each organization can have multiple projects. Use projects to: diff --git a/docs/command/atlas-api-organizations-listOrganizations.txt b/docs/command/atlas-api-organizations-listOrganizations.txt index 769843f5a2..7475d492c0 100644 --- a/docs/command/atlas-api-organizations-listOrganizations.txt +++ b/docs/command/atlas-api-organizations-listOrganizations.txt @@ -14,6 +14,9 @@ atlas api organizations listOrganizations Returns all organizations to which the requesting Service Account or API Key has access. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Member role. 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-listorganizations. diff --git a/docs/command/atlas-api-organizations-updateOrganization.txt b/docs/command/atlas-api-organizations-updateOrganization.txt index 263aaa4854..9d2f6a97a3 100644 --- a/docs/command/atlas-api-organizations-updateOrganization.txt +++ b/docs/command/atlas-api-organizations-updateOrganization.txt @@ -14,6 +14,9 @@ atlas api organizations updateOrganization Updates one organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. 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-updateorganization. diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt index 8f7fb444a1..89d5876a04 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt @@ -14,6 +14,9 @@ atlas api organizations updateOrganizationInvitation Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting API Key must have the Organization Owner role. 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-updateorganizationinvitation. diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt index 175ba7187c..2858acdee9 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt @@ -14,6 +14,9 @@ atlas api organizations updateOrganizationInvitationById Updates the details of one pending invitation, identified by its unique ID, to the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Use the Return All Organization Invitations endpoint to retrieve IDs for all pending organization invitations. To use this resource, the requesting API Key must have the Organization Owner role. 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-updateorganizationinvitationbyid. diff --git a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt b/docs/command/atlas-api-organizations-updateOrganizationRoles.txt index 69c128f9b9..320dce69cf 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationRoles.txt @@ -14,6 +14,9 @@ atlas api organizations updateOrganizationRoles Updates the roles of the specified user in the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization User Admin role. 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-updateorganizationroles. diff --git a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt b/docs/command/atlas-api-organizations-updateOrganizationSettings.txt index 5b31dd9a0f..68427ccb6c 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationSettings.txt @@ -14,6 +14,9 @@ atlas api organizations updateOrganizationSettings Updates the organization's settings. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. 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-updateorganizationsettings. diff --git a/docs/command/atlas-api-organizations.txt b/docs/command/atlas-api-organizations.txt index c354e29e8b..99b9d77eba 100644 --- a/docs/command/atlas-api-organizations.txt +++ b/docs/command/atlas-api-organizations.txt @@ -14,6 +14,11 @@ atlas api organizations Returns, adds, and edits organizational units in MongoDB Cloud. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt b/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt index dd97b4e0da..b8efb335d3 100644 --- a/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt +++ b/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt @@ -14,6 +14,9 @@ atlas api performanceAdvisor disableSlowOperationThresholding Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-disableslowoperationthresholding. diff --git a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt b/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt index 5480d42f83..1da5c3db53 100644 --- a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt +++ b/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt @@ -14,6 +14,9 @@ atlas api performanceAdvisor enableSlowOperationThresholding Enables MongoDB Cloud to use its slow operation threshold for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-enableslowoperationthresholding. diff --git a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt index 4c6dbfb2ba..9b31eeebf0 100644 --- a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt +++ b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt @@ -14,6 +14,9 @@ atlas api performanceAdvisor getManagedSlowMs Get whether the Managed Slow MS feature is enabled. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getmanagedslowms. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt index 07ffffe593..1c82f2ae06 100644 --- a/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt +++ b/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt @@ -14,6 +14,9 @@ atlas api performanceAdvisor getServerlessAutoIndexing Get whether the Serverless Auto Indexing feature is enabled. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This endpoint returns 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. 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-getserverlessautoindexing. diff --git a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt index d2e3c1d4cf..df545afdc1 100644 --- a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt @@ -14,6 +14,9 @@ atlas api performanceAdvisor listClusterSuggestedIndexes Returns the indexes that the Performance Advisor suggests. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listclustersuggestedindexes. diff --git a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt index dae35b215f..d513179fe4 100644 --- a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt @@ -14,6 +14,9 @@ atlas api performanceAdvisor listDropIndexes Returns the indexes that the Performance Advisor suggests to drop. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-listdropindexes. diff --git a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt index be048584e4..f0eb00db8c 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt @@ -14,6 +14,9 @@ atlas api performanceAdvisor listSchemaAdvice Returns the schema suggestions that the Performance Advisor detects. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The Performance Advisor provides holistic schema recommendations for your cluster by sampling documents in your most active collections and collections with slow-running queries. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listschemaadvice. diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt index 4d3a1efaa0..5e1b36bfb2 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt @@ -14,6 +14,9 @@ atlas api performanceAdvisor listSlowQueries Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting Service Account or API Key must have any Project Data Access role or the Project Observability Viewer role. 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-listslowqueries. diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt index f947c644f8..a2974f7a63 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt @@ -14,6 +14,9 @@ atlas api performanceAdvisor listSlowQueryNamespaces Returns up to 20 namespaces for collections experiencing slow queries on the specified host. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listslowquerynamespaces. diff --git a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt index ff5615b53f..62422cd6b9 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt @@ -14,6 +14,9 @@ atlas api performanceAdvisor listSuggestedIndexes Returns the indexes that the Performance Advisor suggests. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listsuggestedindexes. diff --git a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt index eb59172368..5b604f9089 100644 --- a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt +++ b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt @@ -14,6 +14,9 @@ atlas api performanceAdvisor setServerlessAutoIndexing Set whether the Serverless Auto Indexing feature is enabled. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-setserverlessautoindexing. diff --git a/docs/command/atlas-api-performanceAdvisor.txt b/docs/command/atlas-api-performanceAdvisor.txt index 315c90abbd..15925ee0ab 100644 --- a/docs/command/atlas-api-performanceAdvisor.txt +++ b/docs/command/atlas-api-performanceAdvisor.txt @@ -14,6 +14,9 @@ atlas api performanceAdvisor Returns suggested indexes and slow query data for a database deployment. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a sample query, you must have the Project Data Access Read Only role or higher. Otherwise, MongoDB Cloud returns redacted data rather than the field values. Options diff --git a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt index 3585ccd10e..79ff6abc17 100644 --- a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt @@ -14,6 +14,9 @@ atlas api privateEndpointServices createPrivateEndpoint Creates one private endpoint for the specified cloud service provider. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. 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-createprivateendpoint. diff --git a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt index 5311163626..db63746c73 100644 --- a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt @@ -14,6 +14,9 @@ atlas api privateEndpointServices createPrivateEndpointService Creates one private endpoint service for the specified cloud service provider. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-createprivateendpointservice. diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt index ba253449d7..d188c58495 100644 --- a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt @@ -14,6 +14,9 @@ atlas api privateEndpointServices deletePrivateEndpoint Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-deleteprivateendpoint. diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt index 9bc5be6f42..0b6e551ffc 100644 --- a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt @@ -14,6 +14,9 @@ atlas api privateEndpointServices deletePrivateEndpointService Removes one private endpoint service from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-deleteprivateendpointservice. diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt index 400fd0bf33..35bb2044ab 100644 --- a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt @@ -14,6 +14,9 @@ atlas api privateEndpointServices getPrivateEndpoint Returns the connection state of the specified private endpoint. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The private endpoint service manages this private endpoint which belongs to one project hosted from one cloud service provider. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getprivateendpoint. diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt index 2ec0ad94ed..6f80fd3e70 100644 --- a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt @@ -14,6 +14,9 @@ atlas api privateEndpointServices getPrivateEndpointService Returns the name, interfaces, and state of the specified private endpoint service from one project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The cloud service provider hosted this private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getprivateendpointservice. diff --git a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt index 6ea39540bd..7ff1c0a731 100644 --- a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt +++ b/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt @@ -14,6 +14,9 @@ atlas api privateEndpointServices getRegionalizedPrivateEndpointSetting Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The cloud service provider manages the private endpoint for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getregionalizedprivateendpointsetting. diff --git a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt index e9c5c22fdd..9ae804bf83 100644 --- a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt +++ b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt @@ -14,6 +14,9 @@ atlas api privateEndpointServices listPrivateEndpointServices Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-listprivateendpointservices. diff --git a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt index d353db631e..d8c848c1c6 100644 --- a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt +++ b/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt @@ -14,6 +14,9 @@ atlas api privateEndpointServices toggleRegionalizedPrivateEndpointSetting Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-toggleregionalizedprivateendpointsetting. diff --git a/docs/command/atlas-api-privateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices.txt index c294bc065c..198de73ae7 100644 --- a/docs/command/atlas-api-privateEndpointServices.txt +++ b/docs/command/atlas-api-privateEndpointServices.txt @@ -14,6 +14,11 @@ atlas api privateEndpointServices Returns, adds, edits, and removes private endpoint services. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt index 11b5f83b58..f6caeddc6d 100644 --- a/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt @@ -14,6 +14,9 @@ atlas api programmaticApiKeys addProjectApiKey Assigns the specified organization API key to the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-addprojectapikey. diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt index 300998b420..482e04c820 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt @@ -14,6 +14,9 @@ atlas api programmaticApiKeys createApiKey Creates one API key for the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. 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-createapikey. diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt index c5308e6166..af2c7ebad4 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt @@ -14,6 +14,9 @@ atlas api programmaticApiKeys createApiKeyAccessList Creates the access list entries for the specified organization API key. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. 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-createapikeyaccesslist. diff --git a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt index 97c569eb3a..31cf4e93d9 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt @@ -14,6 +14,9 @@ atlas api programmaticApiKeys createProjectApiKey Creates and assigns the specified organization API key to the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-createprojectapikey. diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt index 36777e4b3e..b4cb42ecd3 100644 --- a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt @@ -14,6 +14,9 @@ atlas api programmaticApiKeys deleteApiKey Removes one organization API key from the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. 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-deleteapikey. diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt index 595adcaf98..b4e2d5347b 100644 --- a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt +++ b/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt @@ -14,6 +14,9 @@ atlas api programmaticApiKeys deleteApiKeyAccessListEntry Removes the specified access list entry from the specified organization API key. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. 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-deleteapikeyaccesslistentry. diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt index 100764c58a..60b652425d 100644 --- a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt @@ -14,6 +14,9 @@ atlas api programmaticApiKeys getApiKey Returns one organization API key. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting Service Account or API Key must have the Organization Member role. 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-getapikey. diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt index b84be3b611..7cbb5d4be4 100644 --- a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt +++ b/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt @@ -14,6 +14,9 @@ atlas api programmaticApiKeys getApiKeyAccessList Returns one access list entry for the specified organization API key. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-getapikeyaccesslist. diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt index 938118b3fa..c70db42f8d 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt @@ -14,6 +14,9 @@ atlas api programmaticApiKeys listApiKeyAccessListsEntries Returns all access list entries that you configured for the specified organization API key. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Member role. 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-listapikeyaccesslistsentries. diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt index cafef7876e..d4d3e85e1e 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt @@ -14,6 +14,9 @@ atlas api programmaticApiKeys listApiKeys Returns all organization API keys for the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting Service Account or API Key must have the Organization Member role. 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-listapikeys. diff --git a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt index b6c0497963..a2a673e33a 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt @@ -14,6 +14,9 @@ atlas api programmaticApiKeys listProjectApiKeys Returns all organization API keys that you assigned to the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-listprojectapikeys. diff --git a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt index 085afe7213..d5d32ff48a 100644 --- a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt @@ -14,6 +14,9 @@ atlas api programmaticApiKeys removeProjectApiKey Removes one organization API key from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-removeprojectapikey. diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt index 7dbc02db05..1947e03709 100644 --- a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt @@ -14,6 +14,9 @@ atlas api programmaticApiKeys updateApiKey Updates one organization API key in the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The organization API keys grant programmatic access to an organization. To use this resource, the requesting API Key must have the Organization Owner role. 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-updateapikey. diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt index df7904ca50..f2b8c4513e 100644 --- a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt +++ b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt @@ -14,6 +14,9 @@ atlas api programmaticApiKeys updateApiKeyRoles Updates the roles of the organization API key that you specify for the project that you specify. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-updateapikeyroles. diff --git a/docs/command/atlas-api-programmaticApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys.txt index 550632a4bd..832ca6039e 100644 --- a/docs/command/atlas-api-programmaticApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys.txt @@ -14,6 +14,9 @@ atlas api programmaticApiKeys Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project. Options diff --git a/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt index dbb7b8b834..9330d19852 100644 --- a/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt @@ -14,6 +14,9 @@ atlas api projectIpAccessList createProjectIpAccessList Adds one or more access list entries to the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent POST requests. You must submit multiple POST requests synchronously. 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-createprojectipaccesslist. diff --git a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt index 651ffe83cc..d555a96e99 100644 --- a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt @@ -14,6 +14,9 @@ atlas api projectIpAccessList deleteProjectIpAccessList Removes one access list entry from the specified project's IP access list. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. 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-deleteprojectipaccesslist. diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt index 95936f5879..b8db7093f7 100644 --- a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt +++ b/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt @@ -14,6 +14,9 @@ atlas api projectIpAccessList getProjectIpAccessListStatus Returns the status of one project IP access list entry. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. 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-getprojectipaccessliststatus. diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt index e3af08d688..d8c441affb 100644 --- a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt +++ b/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt @@ -14,6 +14,9 @@ atlas api projectIpAccessList getProjectIpList Returns one access list entry from the specified project's IP access list. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. This endpoint (/groups/{GROUP-ID}/accessList) manages the Project IP Access List. It doesn't manage the access list for MongoDB Cloud organizations. TheProgrammatic API Keys endpoint (/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist) manages those access lists. 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-getprojectiplist. diff --git a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt b/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt index a05ced6098..8bbeba05a9 100644 --- a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt +++ b/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt @@ -14,6 +14,9 @@ atlas api projectIpAccessList listProjectIpAccessLists Returns all access list entries from the specified project's IP access list. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-listprojectipaccesslists. diff --git a/docs/command/atlas-api-projectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList.txt index b82b4215a9..88816f2317 100644 --- a/docs/command/atlas-api-projectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList.txt @@ -14,6 +14,9 @@ atlas api projectIpAccessList Returns, adds, edits, and removes network access limits to database deployments in Atlas. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This resource replaces the whitelist resource. Atlas removed whitelists in July 2021. Update your applications to use this new resource. This resource manages a project's IP Access List and supports creating temporary Access List entries that automatically expire within a user-configurable 7-day period. Options diff --git a/docs/command/atlas-api-projects-addUserToProject.txt b/docs/command/atlas-api-projects-addUserToProject.txt index 4f8a48807b..19c4c42d23 100644 --- a/docs/command/atlas-api-projects-addUserToProject.txt +++ b/docs/command/atlas-api-projects-addUserToProject.txt @@ -14,6 +14,9 @@ atlas api projects addUserToProject Adds one MongoDB Cloud user to the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. 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-addusertoproject. diff --git a/docs/command/atlas-api-projects-createProject.txt b/docs/command/atlas-api-projects-createProject.txt index a2060ad7f6..c4680f999a 100644 --- a/docs/command/atlas-api-projects-createProject.txt +++ b/docs/command/atlas-api-projects-createProject.txt @@ -14,6 +14,9 @@ atlas api projects createProject Creates one project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Read Write role. 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-createproject. diff --git a/docs/command/atlas-api-projects-createProjectInvitation.txt b/docs/command/atlas-api-projects-createProjectInvitation.txt index f4fc05fc9a..ac90ab4983 100644 --- a/docs/command/atlas-api-projects-createProjectInvitation.txt +++ b/docs/command/atlas-api-projects-createProjectInvitation.txt @@ -14,6 +14,9 @@ atlas api projects createProjectInvitation Invites one MongoDB Cloud user to join the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-createprojectinvitation. diff --git a/docs/command/atlas-api-projects-deleteProject.txt b/docs/command/atlas-api-projects-deleteProject.txt index 197da654db..7804600ed4 100644 --- a/docs/command/atlas-api-projects-deleteProject.txt +++ b/docs/command/atlas-api-projects-deleteProject.txt @@ -14,6 +14,9 @@ atlas api projects deleteProject Removes the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-deleteproject. diff --git a/docs/command/atlas-api-projects-deleteProjectInvitation.txt b/docs/command/atlas-api-projects-deleteProjectInvitation.txt index 6cb12632d4..1fc358c4dc 100644 --- a/docs/command/atlas-api-projects-deleteProjectInvitation.txt +++ b/docs/command/atlas-api-projects-deleteProjectInvitation.txt @@ -14,6 +14,9 @@ atlas api projects deleteProjectInvitation Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can't cancel an invitation that the user accepted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-deleteprojectinvitation. diff --git a/docs/command/atlas-api-projects-deleteProjectLimit.txt b/docs/command/atlas-api-projects-deleteProjectLimit.txt index 058103b195..22a77a70d0 100644 --- a/docs/command/atlas-api-projects-deleteProjectLimit.txt +++ b/docs/command/atlas-api-projects-deleteProjectLimit.txt @@ -14,6 +14,9 @@ atlas api projects deleteProjectLimit Removes the specified project limit. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-deleteprojectlimit. diff --git a/docs/command/atlas-api-projects-getProject.txt b/docs/command/atlas-api-projects-getProject.txt index 18ac5d45ff..f9d35f4162 100644 --- a/docs/command/atlas-api-projects-getProject.txt +++ b/docs/command/atlas-api-projects-getProject.txt @@ -14,6 +14,9 @@ atlas api projects getProject Returns details about the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getproject. diff --git a/docs/command/atlas-api-projects-getProjectByName.txt b/docs/command/atlas-api-projects-getProjectByName.txt index d6aefce17a..25796fd130 100644 --- a/docs/command/atlas-api-projects-getProjectByName.txt +++ b/docs/command/atlas-api-projects-getProjectByName.txt @@ -14,6 +14,9 @@ atlas api projects getProjectByName Returns details about the project identified by its name. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. 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-getprojectbyname. diff --git a/docs/command/atlas-api-projects-getProjectInvitation.txt b/docs/command/atlas-api-projects-getProjectInvitation.txt index d79fc0814b..e979d9dbcd 100644 --- a/docs/command/atlas-api-projects-getProjectInvitation.txt +++ b/docs/command/atlas-api-projects-getProjectInvitation.txt @@ -14,6 +14,9 @@ atlas api projects getProjectInvitation Returns the details of one pending invitation to the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-getprojectinvitation. diff --git a/docs/command/atlas-api-projects-getProjectLimit.txt b/docs/command/atlas-api-projects-getProjectLimit.txt index 706df2df74..40fe43f7a2 100644 --- a/docs/command/atlas-api-projects-getProjectLimit.txt +++ b/docs/command/atlas-api-projects-getProjectLimit.txt @@ -14,6 +14,9 @@ atlas api projects getProjectLimit Returns the specified limit for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getprojectlimit. diff --git a/docs/command/atlas-api-projects-getProjectLtsVersions.txt b/docs/command/atlas-api-projects-getProjectLtsVersions.txt index eab6c7735c..cc7b2d354a 100644 --- a/docs/command/atlas-api-projects-getProjectLtsVersions.txt +++ b/docs/command/atlas-api-projects-getProjectLtsVersions.txt @@ -14,6 +14,9 @@ atlas api projects getProjectLtsVersions Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getprojectltsversions. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-projects-getProjectSettings.txt b/docs/command/atlas-api-projects-getProjectSettings.txt index 89f703cd22..08e2a96b4c 100644 --- a/docs/command/atlas-api-projects-getProjectSettings.txt +++ b/docs/command/atlas-api-projects-getProjectSettings.txt @@ -14,6 +14,9 @@ atlas api projects getProjectSettings Returns details about the specified project's settings. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getprojectsettings. diff --git a/docs/command/atlas-api-projects-listProjectInvitations.txt b/docs/command/atlas-api-projects-listProjectInvitations.txt index ec1e2501e4..c971dc1d56 100644 --- a/docs/command/atlas-api-projects-listProjectInvitations.txt +++ b/docs/command/atlas-api-projects-listProjectInvitations.txt @@ -14,6 +14,9 @@ atlas api projects listProjectInvitations Returns all pending invitations to the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-listprojectinvitations. diff --git a/docs/command/atlas-api-projects-listProjectLimits.txt b/docs/command/atlas-api-projects-listProjectLimits.txt index 0d68980db0..b65562cf7f 100644 --- a/docs/command/atlas-api-projects-listProjectLimits.txt +++ b/docs/command/atlas-api-projects-listProjectLimits.txt @@ -14,6 +14,9 @@ atlas api projects listProjectLimits Returns all the limits for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listprojectlimits. diff --git a/docs/command/atlas-api-projects-listProjects.txt b/docs/command/atlas-api-projects-listProjects.txt index f04beb1f60..b7d36ace66 100644 --- a/docs/command/atlas-api-projects-listProjects.txt +++ b/docs/command/atlas-api-projects-listProjects.txt @@ -14,6 +14,9 @@ atlas api projects listProjects Returns details about all projects. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-listprojects. diff --git a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt b/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt index 89bcd50dfd..8333e11cfc 100644 --- a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt +++ b/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt @@ -14,6 +14,9 @@ atlas api projects migrateProjectToAnotherOrg Migrates a project from its current organization to another organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. 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-migrateprojecttoanotherorg. diff --git a/docs/command/atlas-api-projects-returnAllIpAddresses.txt b/docs/command/atlas-api-projects-returnAllIpAddresses.txt index df8b6271f3..9cc1140837 100644 --- a/docs/command/atlas-api-projects-returnAllIpAddresses.txt +++ b/docs/command/atlas-api-projects-returnAllIpAddresses.txt @@ -14,6 +14,9 @@ atlas api projects returnAllIpAddresses Returns all IP addresses for this project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-returnallipaddresses. diff --git a/docs/command/atlas-api-projects-setProjectLimit.txt b/docs/command/atlas-api-projects-setProjectLimit.txt index 6382368f73..95da3e6c2c 100644 --- a/docs/command/atlas-api-projects-setProjectLimit.txt +++ b/docs/command/atlas-api-projects-setProjectLimit.txt @@ -14,6 +14,9 @@ atlas api projects setProjectLimit Sets the specified project limit. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-updateProject.txt b/docs/command/atlas-api-projects-updateProject.txt index f89f9c693c..fdd5c49fb6 100644 --- a/docs/command/atlas-api-projects-updateProject.txt +++ b/docs/command/atlas-api-projects-updateProject.txt @@ -14,6 +14,9 @@ atlas api projects updateProject Updates the human-readable label that identifies the specified project, or the tags associated with the project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-updateproject. diff --git a/docs/command/atlas-api-projects-updateProjectInvitation.txt b/docs/command/atlas-api-projects-updateProjectInvitation.txt index 73d9563076..8dcf58b5a3 100644 --- a/docs/command/atlas-api-projects-updateProjectInvitation.txt +++ b/docs/command/atlas-api-projects-updateProjectInvitation.txt @@ -14,6 +14,9 @@ atlas api projects updateProjectInvitation Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting API Key must have the Project Owner role. 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-updateprojectinvitation. diff --git a/docs/command/atlas-api-projects-updateProjectInvitationById.txt b/docs/command/atlas-api-projects-updateProjectInvitationById.txt index 571a936002..6d15d9b9ea 100644 --- a/docs/command/atlas-api-projects-updateProjectInvitationById.txt +++ b/docs/command/atlas-api-projects-updateProjectInvitationById.txt @@ -14,6 +14,9 @@ atlas api projects updateProjectInvitationById Updates the details of one pending invitation, identified by its unique ID, to the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role. 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-updateprojectinvitationbyid. diff --git a/docs/command/atlas-api-projects-updateProjectRoles.txt b/docs/command/atlas-api-projects-updateProjectRoles.txt index d4f4ad6e0e..e99660b40b 100644 --- a/docs/command/atlas-api-projects-updateProjectRoles.txt +++ b/docs/command/atlas-api-projects-updateProjectRoles.txt @@ -14,6 +14,9 @@ atlas api projects updateProjectRoles Updates the roles of the specified user in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. 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-updateprojectroles. diff --git a/docs/command/atlas-api-projects-updateProjectSettings.txt b/docs/command/atlas-api-projects-updateProjectSettings.txt index 5bd00c6f38..cc7f63fa82 100644 --- a/docs/command/atlas-api-projects-updateProjectSettings.txt +++ b/docs/command/atlas-api-projects-updateProjectSettings.txt @@ -14,6 +14,9 @@ atlas api projects updateProjectSettings Updates the settings of the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-updateprojectsettings. diff --git a/docs/command/atlas-api-projects.txt b/docs/command/atlas-api-projects.txt index 0d639c8436..a7392364a6 100644 --- a/docs/command/atlas-api-projects.txt +++ b/docs/command/atlas-api-projects.txt @@ -14,6 +14,11 @@ atlas api projects Returns, adds, and edits collections of clusters and users in MongoDB Cloud. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt index ab0c25c2f5..b3b11571ff 100644 --- a/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt @@ -14,6 +14,9 @@ atlas api pushBasedLogExport createPushBasedLogConfiguration Configures the project level settings for the push-based log export feature. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-createpushbasedlogconfiguration. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt index 0f6134e110..bf5b231264 100644 --- a/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt @@ -14,6 +14,9 @@ atlas api pushBasedLogExport deletePushBasedLogConfiguration Disables the push-based log export feature by resetting the project level settings to its default configuration. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-deletepushbasedlogconfiguration. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt index 0a233c51c6..b5c4523817 100644 --- a/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt @@ -14,6 +14,9 @@ atlas api pushBasedLogExport getPushBasedLogConfiguration Fetches the current project level settings for the push-based log export feature. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getpushbasedlogconfiguration. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt index ff67b68b11..c3b6e3ba4e 100644 --- a/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt @@ -14,6 +14,9 @@ atlas api pushBasedLogExport updatePushBasedLogConfiguration Updates the project level settings for the push-based log export feature. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-updatepushbasedlogconfiguration. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-pushBasedLogExport.txt b/docs/command/atlas-api-pushBasedLogExport.txt index 681ae65512..31b2e37cf2 100644 --- a/docs/command/atlas-api-pushBasedLogExport.txt +++ b/docs/command/atlas-api-pushBasedLogExport.txt @@ -14,6 +14,9 @@ atlas api pushBasedLogExport You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Atlas exports logs every 5 minutes. Options diff --git a/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt b/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt index 241912541b..31b72ef023 100644 --- a/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt +++ b/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt @@ -14,6 +14,9 @@ atlas api queryShapeInsights getGroupClusterQueryShapeInsightDetails Returns the metadata and statistics summary for a given query shape hash. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getgroupclusterqueryshapeinsightdetails. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries.txt b/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries.txt index 1321149220..7fa108bd5c 100644 --- a/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries.txt +++ b/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries.txt @@ -14,6 +14,9 @@ atlas api queryShapeInsights getGroupClusterQueryShapeInsightSummaries Returns a list of query shape statistics summaries for a given cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Query shape statistics provide performance insights about MongoDB queries, helping users identify problematic query patterns and potential optimizations. 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-getgroupclusterqueryshapeinsightsummaries. diff --git a/docs/command/atlas-api-queryShapeInsights.txt b/docs/command/atlas-api-queryShapeInsights.txt index 71ad351fd5..8cbf6fe330 100644 --- a/docs/command/atlas-api-queryShapeInsights.txt +++ b/docs/command/atlas-api-queryShapeInsights.txt @@ -14,6 +14,11 @@ atlas api queryShapeInsights +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-resourcePolicies-createOrgResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-createOrgResourcePolicy.txt index b45bc7257c..fa35ac286e 100644 --- a/docs/command/atlas-api-resourcePolicies-createOrgResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-createOrgResourcePolicy.txt @@ -14,6 +14,9 @@ atlas api resourcePolicies createOrgResourcePolicy Create one Atlas Resource Policy for an org. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-createorgresourcepolicy. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-resourcePolicies-deleteOrgResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-deleteOrgResourcePolicy.txt index 0d3ccfb3bb..edb09e9238 100644 --- a/docs/command/atlas-api-resourcePolicies-deleteOrgResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-deleteOrgResourcePolicy.txt @@ -14,6 +14,9 @@ atlas api resourcePolicies deleteOrgResourcePolicy Delete one Atlas Resource Policy for an org. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-deleteorgresourcepolicy. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-resourcePolicies-getOrgResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-getOrgResourcePolicy.txt index adc9ba5449..59090e50dc 100644 --- a/docs/command/atlas-api-resourcePolicies-getOrgResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-getOrgResourcePolicy.txt @@ -14,6 +14,9 @@ atlas api resourcePolicies getOrgResourcePolicy Return one Atlas Resource Policy for an org. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getorgresourcepolicy. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt b/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt index 4fbd2f54c9..d2b57b2f29 100644 --- a/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt +++ b/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt @@ -14,6 +14,9 @@ atlas api resourcePolicies getResourcesNonCompliant Return all non-compliant resources for an org. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getresourcesnoncompliant. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-resourcePolicies-listOrgResourcePolicies.txt b/docs/command/atlas-api-resourcePolicies-listOrgResourcePolicies.txt index 8894e99da9..b950d73b05 100644 --- a/docs/command/atlas-api-resourcePolicies-listOrgResourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies-listOrgResourcePolicies.txt @@ -14,6 +14,9 @@ atlas api resourcePolicies listOrgResourcePolicies Return all Atlas Resource Policies for the org. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-listorgresourcepolicies. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-resourcePolicies-updateOrgResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-updateOrgResourcePolicy.txt index 99aa42b6aa..78b3321452 100644 --- a/docs/command/atlas-api-resourcePolicies-updateOrgResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-updateOrgResourcePolicy.txt @@ -14,6 +14,9 @@ atlas api resourcePolicies updateOrgResourcePolicy Update one Atlas Resource Policy for an org. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-updateorgresourcepolicy. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt index c4c1e0dd63..e014058cd3 100644 --- a/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt @@ -14,6 +14,9 @@ atlas api resourcePolicies validateAtlasResourcePolicy Validate one Atlas Resource Policy for an org. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-validateatlasresourcepolicy. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-resourcePolicies.txt b/docs/command/atlas-api-resourcePolicies.txt index 3ec715b776..d124b01903 100644 --- a/docs/command/atlas-api-resourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies.txt @@ -14,6 +14,11 @@ atlas api resourcePolicies Configure and manage Atlas Resource Policies within your organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-rollingIndex-createRollingIndex.txt b/docs/command/atlas-api-rollingIndex-createRollingIndex.txt index f592281958..24484fa85d 100644 --- a/docs/command/atlas-api-rollingIndex-createRollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex-createRollingIndex.txt @@ -14,6 +14,9 @@ atlas api rollingIndex createRollingIndex Creates an index on the cluster identified by its name in a rolling manner. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. 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-createrollingindex. diff --git a/docs/command/atlas-api-rollingIndex.txt b/docs/command/atlas-api-rollingIndex.txt index 2f84fc5ce0..d00329ce6c 100644 --- a/docs/command/atlas-api-rollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex.txt @@ -14,6 +14,9 @@ atlas api rollingIndex Creates one index to a database deployment in a rolling manner. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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/atlas-api-root-getSystemStatus.txt b/docs/command/atlas-api-root-getSystemStatus.txt index e0bfad2969..e75299640b 100644 --- a/docs/command/atlas-api-root-getSystemStatus.txt +++ b/docs/command/atlas-api-root-getSystemStatus.txt @@ -14,6 +14,9 @@ atlas api root getSystemStatus This resource returns information about the MongoDB application along with API key meta data. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getsystemstatus. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt b/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt index fa166ec9e2..1f6221a884 100644 --- a/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt +++ b/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt @@ -14,6 +14,9 @@ atlas api root returnAllControlPlaneIpAddresses Returns all control plane IP addresses. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-returnallcontrolplaneipaddresses. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-root.txt b/docs/command/atlas-api-root.txt index 00f2658f32..99c4bda3e1 100644 --- a/docs/command/atlas-api-root.txt +++ b/docs/command/atlas-api-root.txt @@ -14,6 +14,9 @@ atlas api root Returns details that describe the MongoDB Cloud build and the access token that requests this resource. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This starts the MongoDB Cloud API. Options diff --git a/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt index b5ab0cd2bb..cfbab604a6 100644 --- a/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt @@ -14,6 +14,9 @@ atlas api serverlessInstances createServerlessInstance Update as of Feb 2025: This endpoint now creates a Flex cluster instead. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This endpoint will no longer be supported starting January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect. Please use the createFlexCluster endpoint instead. diff --git a/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt index 47ed45df61..fe5f34cad7 100644 --- a/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt @@ -14,6 +14,9 @@ atlas api serverlessInstances deleteServerlessInstance Removes one serverless instance from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt index 7a6d6acf4b..419b8065f3 100644 --- a/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt @@ -14,6 +14,9 @@ atlas api serverlessInstances getServerlessInstance Returns details for one serverless instance in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt b/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt index 7334eba6aa..658d4daf43 100644 --- a/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt +++ b/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt @@ -14,6 +14,9 @@ atlas api serverlessInstances listServerlessInstances Returns details for all serverless instances in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt index 57fe53978a..f790e2147e 100644 --- a/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt @@ -14,6 +14,9 @@ atlas api serverlessInstances updateServerlessInstance Updates one serverless instance in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessInstances.txt b/docs/command/atlas-api-serverlessInstances.txt index 1b20516e01..e01749f5ea 100644 --- a/docs/command/atlas-api-serverlessInstances.txt +++ b/docs/command/atlas-api-serverlessInstances.txt @@ -14,6 +14,11 @@ atlas api serverlessInstances Returns, adds, edits, and removes serverless instances. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt index 80baea5741..f13bd1c7fe 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt @@ -14,6 +14,9 @@ atlas api serverlessPrivateEndpoints createServerlessPrivateEndpoint Creates one private endpoint for one serverless instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt index a35db2ae11..d77d8cc87d 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt @@ -14,6 +14,9 @@ atlas api serverlessPrivateEndpoints deleteServerlessPrivateEndpoint Remove one private endpoint from one serverless instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt index aa27d86010..1625751472 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt @@ -14,6 +14,9 @@ atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint Return one private endpoint for one serverless instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt index 59738432ca..a4f8bb425d 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt @@ -14,6 +14,9 @@ atlas api serverlessPrivateEndpoints listServerlessPrivateEndpoints Returns all private endpoints for one serverless instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You must have at least the Project Read Only role for the project to successfully call this resource. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt index 2c72dce4b1..86e533e689 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt @@ -14,6 +14,9 @@ atlas api serverlessPrivateEndpoints updateServerlessPrivateEndpoint Updates one private endpoint for one serverless instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints.txt b/docs/command/atlas-api-serverlessPrivateEndpoints.txt index 5bbbd72a5f..6340ff98aa 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints.txt @@ -14,6 +14,9 @@ atlas api serverlessPrivateEndpoints Returns, adds, edits, and removes private endpoints for serverless instances. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To learn more, see the Atlas Administration API tab on the following tutorial. Options diff --git a/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt index 92909c0310..e3e73537da 100644 --- a/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts addProjectServiceAccount Assigns the specified Service Account to the specified Project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-addprojectserviceaccount. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt index 293f55c912..af6842feeb 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts createProjectServiceAccount Creates one Service Account for the specified Project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. 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-createprojectserviceaccount. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt index 5fc27e6217..6baac0e201 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts createProjectServiceAccountAccessList Add Access List Entries for the specified Service Account for the project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Resources require all API requests to originate from IP addresses on the API access list. 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-createprojectserviceaccountaccesslist. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt index 6596f43fb7..1247ec87c9 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts createProjectServiceAccountSecret Create a secret for the specified Service Account in the specified Project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-createprojectserviceaccountsecret. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt index 5034f1632d..e03fe17618 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts createServiceAccount Creates one Service Account for the specified Organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-createserviceaccount. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt index 11eeb30f0e..1894076f8b 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts createServiceAccountAccessList Add Access List Entries for the specified Service Account for the organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Resources require all API requests to originate from IP addresses on the API access list. 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-createserviceaccountaccesslist. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt index 4e17601bbe..cc20908c00 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts createServiceAccountSecret Create a secret for the specified Service Account. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-createserviceaccountsecret. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt index c126719485..30ffbe4af9 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts deleteProjectServiceAccount Removes the specified Service Account from the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + The Service Account will still be a part of the Organization it was created in, and the credentials will remain active until expired or manually revoked. 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-deleteprojectserviceaccount. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt index 66c9dd3a55..af88dddd78 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts deleteProjectServiceAccountAccessListEntry Removes the specified access list entry from the specified Service Account for the project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can't remove the requesting IP address from the access list. 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-deleteprojectserviceaccountaccesslistentry. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt index 5c8384b50a..b906a062fe 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts deleteProjectServiceAccountSecret Deletes the specified Service Account secret. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-deleteprojectserviceaccountsecret. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt index ee39b95d77..dc8be5ca12 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts deleteServiceAccount Deletes the specified Service Account. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-deleteserviceaccount. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt index 2168e11c57..4e5afea548 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts deleteServiceAccountAccessListEntry Removes the specified access list entry from the specified Service Account for the organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can't remove the requesting IP address from the access list. 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-deleteserviceaccountaccesslistentry. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt index 1872eebbd3..069515646c 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts deleteServiceAccountSecret Deletes the specified Service Account secret. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-deleteserviceaccountsecret. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt index c17afa1b40..65614cdafb 100644 --- a/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts getProjectServiceAccount Returns one Service Account in the specified Project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getprojectserviceaccount. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt index 08ce892ba9..58455e4688 100644 --- a/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts getServiceAccount Returns the specified Service Account. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getserviceaccount. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt index fef90b3a1c..baaa00ea6c 100644 --- a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts listProjectServiceAccountAccessList Returns all access list entries that you configured for the specified Service Account for the project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-listprojectserviceaccountaccesslist. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt index 2bd9398b77..91f14a2506 100644 --- a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts listProjectServiceAccounts Returns all Service Accounts for the specified Project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-listprojectserviceaccounts. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt index 5d13cbef93..c7cc6ab266 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts listServiceAccountAccessList Returns all access list entries that you configured for the specified Service Account for the organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-listserviceaccountaccesslist. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt index 5841c503a5..d18b44a5c3 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts listServiceAccountProjects Returns a list of all projects the specified Service Account is a part of. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-listserviceaccountprojects. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt index 30e5bbc1be..8d32a989cc 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts listServiceAccounts Returns all Service Accounts for the specified Organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-listserviceaccounts. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt index 82b31d1129..b2ae2a4245 100644 --- a/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts updateProjectServiceAccount Updates one Service Account in the specified Project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-updateprojectserviceaccount. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt index 8ff26fac2d..26b69db158 100644 --- a/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts updateServiceAccount Updates the specified Service Account in the specified Organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-updateserviceaccount. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-serviceAccounts.txt b/docs/command/atlas-api-serviceAccounts.txt index 8c9d2b0037..947cce9972 100644 --- a/docs/command/atlas-api-serviceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts.txt @@ -14,6 +14,9 @@ atlas api serviceAccounts Endpoints for managing Service Accounts and secrets. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow. Options diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt b/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt index a156451f58..367ead3cd2 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt @@ -14,6 +14,9 @@ atlas api sharedTierRestoreJobs createSharedClusterBackupRestoreJob Restores the specified M2 or M5 cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt b/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt index b605703043..138c5d5555 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt @@ -14,6 +14,9 @@ atlas api sharedTierRestoreJobs getSharedClusterBackupRestoreJob Returns the specified restore job for the specified M2 or M5 cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt b/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt index 83718b668c..b8c7f326a3 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt @@ -14,6 +14,9 @@ atlas api sharedTierRestoreJobs listSharedClusterBackupRestoreJobs Returns all restore jobs for the specified M2 or M5 cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Restore jobs restore a cluster using a snapshot. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-sharedTierRestoreJobs.txt b/docs/command/atlas-api-sharedTierRestoreJobs.txt index 92bc4c2959..d78199219e 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs.txt @@ -14,6 +14,11 @@ atlas api sharedTierRestoreJobs Returns and adds restore jobs for shared-tier database deployments. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt b/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt index 65168c0c94..d3b00c96c6 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt @@ -14,6 +14,9 @@ atlas api sharedTierSnapshots downloadSharedClusterBackup Requests one snapshot for the specified shared cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt b/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt index b1c1b49d47..cbeac7cba8 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt @@ -14,6 +14,9 @@ atlas api sharedTierSnapshots getSharedClusterBackup Returns details for one snapshot for the specified shared cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt b/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt index 43c7110be2..053868d3d4 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt @@ -14,6 +14,9 @@ atlas api sharedTierSnapshots listSharedClusterBackups Returns details for all snapshots for the specified shared cluster. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-sharedTierSnapshots.txt b/docs/command/atlas-api-sharedTierSnapshots.txt index 8c902f18e3..046a4697ed 100644 --- a/docs/command/atlas-api-sharedTierSnapshots.txt +++ b/docs/command/atlas-api-sharedTierSnapshots.txt @@ -14,6 +14,11 @@ atlas api sharedTierSnapshots Returns and requests to download shared-tier database deployment snapshots. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt b/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt index c1c69255c2..048acd19b1 100644 --- a/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt @@ -14,6 +14,9 @@ atlas api streams acceptVpcPeeringConnection Requests the acceptance of an incoming VPC Peering connection. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-acceptvpcpeeringconnection. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-streams-createPrivateLinkConnection.txt b/docs/command/atlas-api-streams-createPrivateLinkConnection.txt index 375f441502..04937ef12d 100644 --- a/docs/command/atlas-api-streams-createPrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-createPrivateLinkConnection.txt @@ -14,6 +14,9 @@ atlas api streams createPrivateLinkConnection Creates one Private Link in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. 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-createprivatelinkconnection. diff --git a/docs/command/atlas-api-streams-createStreamConnection.txt b/docs/command/atlas-api-streams-createStreamConnection.txt index 28c658b1b9..ab0f87d430 100644 --- a/docs/command/atlas-api-streams-createStreamConnection.txt +++ b/docs/command/atlas-api-streams-createStreamConnection.txt @@ -14,6 +14,9 @@ atlas api streams createStreamConnection Creates one connection for a stream instance in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. 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-createstreamconnection. diff --git a/docs/command/atlas-api-streams-createStreamInstance.txt b/docs/command/atlas-api-streams-createStreamInstance.txt index ea81567c81..b4008fe123 100644 --- a/docs/command/atlas-api-streams-createStreamInstance.txt +++ b/docs/command/atlas-api-streams-createStreamInstance.txt @@ -14,6 +14,9 @@ atlas api streams createStreamInstance Creates one stream instance in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. 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-createstreaminstance. diff --git a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt b/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt index f8ec21c4f3..dda8a9a34c 100644 --- a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt +++ b/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt @@ -14,6 +14,9 @@ atlas api streams createStreamInstanceWithSampleConnections Creates one stream instance in the specified project with sample connections. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. 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-createstreaminstancewithsampleconnections. diff --git a/docs/command/atlas-api-streams-createStreamProcessor.txt b/docs/command/atlas-api-streams-createStreamProcessor.txt index dd3432daa4..1e923f9191 100644 --- a/docs/command/atlas-api-streams-createStreamProcessor.txt +++ b/docs/command/atlas-api-streams-createStreamProcessor.txt @@ -14,6 +14,9 @@ atlas api streams createStreamProcessor Create one Stream Processor within the specified stream instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. 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-createstreamprocessor. diff --git a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt index 86bfcc979f..d431b3651b 100644 --- a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt @@ -14,6 +14,9 @@ atlas api streams deletePrivateLinkConnection Deletes one Private Link in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. 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-deleteprivatelinkconnection. diff --git a/docs/command/atlas-api-streams-deleteStreamConnection.txt b/docs/command/atlas-api-streams-deleteStreamConnection.txt index 5c3b49fdc7..ff056ecb20 100644 --- a/docs/command/atlas-api-streams-deleteStreamConnection.txt +++ b/docs/command/atlas-api-streams-deleteStreamConnection.txt @@ -14,6 +14,9 @@ atlas api streams deleteStreamConnection Delete one connection of the specified stream instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. 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-deletestreamconnection. diff --git a/docs/command/atlas-api-streams-deleteStreamInstance.txt b/docs/command/atlas-api-streams-deleteStreamInstance.txt index 45d959c8db..1369900e34 100644 --- a/docs/command/atlas-api-streams-deleteStreamInstance.txt +++ b/docs/command/atlas-api-streams-deleteStreamInstance.txt @@ -14,6 +14,9 @@ atlas api streams deleteStreamInstance Delete one stream instance in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. 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-deletestreaminstance. diff --git a/docs/command/atlas-api-streams-deleteStreamProcessor.txt b/docs/command/atlas-api-streams-deleteStreamProcessor.txt index c91f192826..06932cfe64 100644 --- a/docs/command/atlas-api-streams-deleteStreamProcessor.txt +++ b/docs/command/atlas-api-streams-deleteStreamProcessor.txt @@ -14,6 +14,9 @@ atlas api streams deleteStreamProcessor Delete a Stream Processor within the specified stream instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. 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-deletestreamprocessor. diff --git a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt index fb0246c181..1a97c5f5ad 100644 --- a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt @@ -14,6 +14,9 @@ atlas api streams deleteVpcPeeringConnection Deletes an incoming VPC Peering connection. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-deletevpcpeeringconnection. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt b/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt index 4243ae0783..674097e5c6 100644 --- a/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt +++ b/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt @@ -14,6 +14,9 @@ atlas api streams downloadStreamTenantAuditLogs Downloads the audit logs for the specified Atlas Streams Processing instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + By default, logs cover periods of 30 days. To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". 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-downloadstreamtenantauditlogs. diff --git a/docs/command/atlas-api-streams-getAccountDetails.txt b/docs/command/atlas-api-streams-getAccountDetails.txt index a9c21cea67..c0823e168d 100644 --- a/docs/command/atlas-api-streams-getAccountDetails.txt +++ b/docs/command/atlas-api-streams-getAccountDetails.txt @@ -14,6 +14,9 @@ atlas api streams getAccountDetails Returns the Account ID, and the VPC ID for the group and region specified. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getaccountdetails. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt index 410e6177c1..e55c4728e6 100644 --- a/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt +++ b/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt @@ -14,6 +14,9 @@ atlas api streams getActiveVpcPeeringConnections Returns a list of active incoming VPC Peering Connections. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getactivevpcpeeringconnections. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt index db2452b3ad..f5e92532de 100644 --- a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt @@ -14,6 +14,9 @@ atlas api streams getPrivateLinkConnection Returns the details of one Private Link connection within the project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getprivatelinkconnection. diff --git a/docs/command/atlas-api-streams-getStreamConnection.txt b/docs/command/atlas-api-streams-getStreamConnection.txt index 080db29980..5d084f3e96 100644 --- a/docs/command/atlas-api-streams-getStreamConnection.txt +++ b/docs/command/atlas-api-streams-getStreamConnection.txt @@ -14,6 +14,9 @@ atlas api streams getStreamConnection Returns the details of one stream connection within the specified stream instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-getstreamconnection. diff --git a/docs/command/atlas-api-streams-getStreamInstance.txt b/docs/command/atlas-api-streams-getStreamInstance.txt index e2a5eb4d27..5c6e96a27b 100644 --- a/docs/command/atlas-api-streams-getStreamInstance.txt +++ b/docs/command/atlas-api-streams-getStreamInstance.txt @@ -14,6 +14,9 @@ atlas api streams getStreamInstance Returns the details of one stream instance within the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-getstreaminstance. diff --git a/docs/command/atlas-api-streams-getStreamProcessor.txt b/docs/command/atlas-api-streams-getStreamProcessor.txt index 44145d14d5..f32b796cfd 100644 --- a/docs/command/atlas-api-streams-getStreamProcessor.txt +++ b/docs/command/atlas-api-streams-getStreamProcessor.txt @@ -14,6 +14,9 @@ atlas api streams getStreamProcessor Get one Stream Processor within the specified stream instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. 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-getstreamprocessor. diff --git a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getVpcPeeringConnections.txt index a8e81c7e6a..b7f905c5c7 100644 --- a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt +++ b/docs/command/atlas-api-streams-getVpcPeeringConnections.txt @@ -14,6 +14,9 @@ atlas api streams getVpcPeeringConnections Returns a list of incoming VPC Peering Connections. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-getvpcpeeringconnections. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-streams-listPrivateLinkConnections.txt b/docs/command/atlas-api-streams-listPrivateLinkConnections.txt index b20e1c79f8..816253e128 100644 --- a/docs/command/atlas-api-streams-listPrivateLinkConnections.txt +++ b/docs/command/atlas-api-streams-listPrivateLinkConnections.txt @@ -14,6 +14,9 @@ atlas api streams listPrivateLinkConnections Returns all Private Link connections for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. 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-listprivatelinkconnections. diff --git a/docs/command/atlas-api-streams-listStreamConnections.txt b/docs/command/atlas-api-streams-listStreamConnections.txt index 083a69fd8d..7195c421fb 100644 --- a/docs/command/atlas-api-streams-listStreamConnections.txt +++ b/docs/command/atlas-api-streams-listStreamConnections.txt @@ -14,6 +14,9 @@ atlas api streams listStreamConnections Returns all connections of the stream instance for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. 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-liststreamconnections. diff --git a/docs/command/atlas-api-streams-listStreamInstances.txt b/docs/command/atlas-api-streams-listStreamInstances.txt index 6bd2b7ce8b..4f99bcbee5 100644 --- a/docs/command/atlas-api-streams-listStreamInstances.txt +++ b/docs/command/atlas-api-streams-listStreamInstances.txt @@ -14,6 +14,9 @@ atlas api streams listStreamInstances Returns all stream instances for the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-liststreaminstances. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-streams-listStreamProcessors.txt b/docs/command/atlas-api-streams-listStreamProcessors.txt index fd904c0fcc..3c8ab7dfa6 100644 --- a/docs/command/atlas-api-streams-listStreamProcessors.txt +++ b/docs/command/atlas-api-streams-listStreamProcessors.txt @@ -14,6 +14,9 @@ atlas api streams listStreamProcessors Returns all Stream Processors within the specified stream instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. 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-liststreamprocessors. diff --git a/docs/command/atlas-api-streams-modifyStreamProcessor.txt b/docs/command/atlas-api-streams-modifyStreamProcessor.txt index d25c4ab355..bf78e57b4e 100644 --- a/docs/command/atlas-api-streams-modifyStreamProcessor.txt +++ b/docs/command/atlas-api-streams-modifyStreamProcessor.txt @@ -14,6 +14,9 @@ atlas api streams modifyStreamProcessor Modify one existing Stream Processor within the specified stream instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. 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-modifystreamprocessor. diff --git a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt index 4d85b8ba37..c5091c3b51 100644 --- a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt @@ -14,6 +14,9 @@ atlas api streams rejectVpcPeeringConnection Requests the rejection of an incoming VPC Peering connection. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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-rejectvpcpeeringconnection. For more information and examples, see the referenced API documentation linked above. diff --git a/docs/command/atlas-api-streams-startStreamProcessor.txt b/docs/command/atlas-api-streams-startStreamProcessor.txt index 218932e16b..3b1ff9a942 100644 --- a/docs/command/atlas-api-streams-startStreamProcessor.txt +++ b/docs/command/atlas-api-streams-startStreamProcessor.txt @@ -14,6 +14,9 @@ atlas api streams startStreamProcessor Start a Stream Processor within the specified stream instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. 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-startstreamprocessor. diff --git a/docs/command/atlas-api-streams-startStreamProcessorWith.txt b/docs/command/atlas-api-streams-startStreamProcessorWith.txt index 1fd321ce19..fb007a3b46 100644 --- a/docs/command/atlas-api-streams-startStreamProcessorWith.txt +++ b/docs/command/atlas-api-streams-startStreamProcessorWith.txt @@ -14,6 +14,9 @@ atlas api streams startStreamProcessorWith Start a Stream Processor within the specified stream instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. 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-startstreamprocessorwith. diff --git a/docs/command/atlas-api-streams-stopStreamProcessor.txt b/docs/command/atlas-api-streams-stopStreamProcessor.txt index fba0a092a0..4493133470 100644 --- a/docs/command/atlas-api-streams-stopStreamProcessor.txt +++ b/docs/command/atlas-api-streams-stopStreamProcessor.txt @@ -14,6 +14,9 @@ atlas api streams stopStreamProcessor Stop a Stream Processor within the specified stream instance. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. 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-stopstreamprocessor. diff --git a/docs/command/atlas-api-streams-updateStreamConnection.txt b/docs/command/atlas-api-streams-updateStreamConnection.txt index e628ecbb2a..a0bec2f9bb 100644 --- a/docs/command/atlas-api-streams-updateStreamConnection.txt +++ b/docs/command/atlas-api-streams-updateStreamConnection.txt @@ -14,6 +14,9 @@ atlas api streams updateStreamConnection Update one connection for the specified stream instance in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. 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-updatestreamconnection. diff --git a/docs/command/atlas-api-streams-updateStreamInstance.txt b/docs/command/atlas-api-streams-updateStreamInstance.txt index eb696b2f74..7f3faf6a8c 100644 --- a/docs/command/atlas-api-streams-updateStreamInstance.txt +++ b/docs/command/atlas-api-streams-updateStreamInstance.txt @@ -14,6 +14,9 @@ atlas api streams updateStreamInstance Update one stream instance in the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. 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-updatestreaminstance. diff --git a/docs/command/atlas-api-streams.txt b/docs/command/atlas-api-streams.txt index aab49419fc..5a1648621b 100644 --- a/docs/command/atlas-api-streams.txt +++ b/docs/command/atlas-api-streams.txt @@ -14,6 +14,9 @@ atlas api streams Returns, adds, edits, and removes Streams Instances. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This resource requires your project ID. Options diff --git a/docs/command/atlas-api-teams-addAllTeamsToProject.txt b/docs/command/atlas-api-teams-addAllTeamsToProject.txt index cddf5582b7..74e2f8ae20 100644 --- a/docs/command/atlas-api-teams-addAllTeamsToProject.txt +++ b/docs/command/atlas-api-teams-addAllTeamsToProject.txt @@ -14,6 +14,9 @@ atlas api teams addAllTeamsToProject Adds one or more teams to the specified project. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + All members of the team share the same project access. MongoDB Cloud limits the number of users to a maximum of 100 teams per project and a maximum of 250 teams per organization. To use this resource, the requesting API Key must have the Project Owner role. 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-addallteamstoproject. diff --git a/docs/command/atlas-api-teams-addTeamUser.txt b/docs/command/atlas-api-teams-addTeamUser.txt index 51bbf719f6..b28f6d724a 100644 --- a/docs/command/atlas-api-teams-addTeamUser.txt +++ b/docs/command/atlas-api-teams-addTeamUser.txt @@ -14,6 +14,9 @@ atlas api teams addTeamUser Adds one or more MongoDB Cloud users from the specified organization to the specified team. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-teams-createTeam.txt b/docs/command/atlas-api-teams-createTeam.txt index 80be91af11..d770e77f54 100644 --- a/docs/command/atlas-api-teams-createTeam.txt +++ b/docs/command/atlas-api-teams-createTeam.txt @@ -14,6 +14,9 @@ atlas api teams createTeam Creates one team in the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits the number of teams to a maximum of 250 teams per organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. 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-createteam. diff --git a/docs/command/atlas-api-teams-deleteTeam.txt b/docs/command/atlas-api-teams-deleteTeam.txt index cb76bb1a41..100acf505b 100644 --- a/docs/command/atlas-api-teams-deleteTeam.txt +++ b/docs/command/atlas-api-teams-deleteTeam.txt @@ -14,6 +14,9 @@ atlas api teams deleteTeam Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Organization Owner role. 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-deleteteam. diff --git a/docs/command/atlas-api-teams-getProjectTeam.txt b/docs/command/atlas-api-teams-getProjectTeam.txt index 35619c66c3..d5db50c497 100644 --- a/docs/command/atlas-api-teams-getProjectTeam.txt +++ b/docs/command/atlas-api-teams-getProjectTeam.txt @@ -14,6 +14,9 @@ atlas api teams getProjectTeam Returns one team to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-getprojectteam. diff --git a/docs/command/atlas-api-teams-getTeamById.txt b/docs/command/atlas-api-teams-getTeamById.txt index 7f0dcfd6d1..2604fcdc63 100644 --- a/docs/command/atlas-api-teams-getTeamById.txt +++ b/docs/command/atlas-api-teams-getTeamById.txt @@ -14,6 +14,9 @@ atlas api teams getTeamById Returns one team that you identified using its unique 24-hexadecimal digit ID. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. 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-getteambyid. diff --git a/docs/command/atlas-api-teams-getTeamByName.txt b/docs/command/atlas-api-teams-getTeamByName.txt index 62167eb330..be218ac91a 100644 --- a/docs/command/atlas-api-teams-getTeamByName.txt +++ b/docs/command/atlas-api-teams-getTeamByName.txt @@ -14,6 +14,9 @@ atlas api teams getTeamByName Returns one team that you identified using its human-readable name. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. 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-getteambyname. diff --git a/docs/command/atlas-api-teams-listOrganizationTeams.txt b/docs/command/atlas-api-teams-listOrganizationTeams.txt index 93abfabac2..78e2f4a4f6 100644 --- a/docs/command/atlas-api-teams-listOrganizationTeams.txt +++ b/docs/command/atlas-api-teams-listOrganizationTeams.txt @@ -14,6 +14,9 @@ atlas api teams listOrganizationTeams Returns all teams that belong to the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. 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-listorganizationteams. diff --git a/docs/command/atlas-api-teams-listProjectTeams.txt b/docs/command/atlas-api-teams-listProjectTeams.txt index 0b93fe4202..bc88698817 100644 --- a/docs/command/atlas-api-teams-listProjectTeams.txt +++ b/docs/command/atlas-api-teams-listProjectTeams.txt @@ -14,6 +14,9 @@ atlas api teams listProjectTeams Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + 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. 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-listprojectteams. diff --git a/docs/command/atlas-api-teams-removeProjectTeam.txt b/docs/command/atlas-api-teams-removeProjectTeam.txt index 80f326b417..733be552c1 100644 --- a/docs/command/atlas-api-teams-removeProjectTeam.txt +++ b/docs/command/atlas-api-teams-removeProjectTeam.txt @@ -14,6 +14,9 @@ atlas api teams removeProjectTeam Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-removeprojectteam. diff --git a/docs/command/atlas-api-teams-removeTeamUser.txt b/docs/command/atlas-api-teams-removeTeamUser.txt index 41589e8457..bfa0147576 100644 --- a/docs/command/atlas-api-teams-removeTeamUser.txt +++ b/docs/command/atlas-api-teams-removeTeamUser.txt @@ -14,6 +14,9 @@ atlas api teams removeTeamUser Removes one MongoDB Cloud user from the specified team. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-teams-renameTeam.txt b/docs/command/atlas-api-teams-renameTeam.txt index d574358b6c..e5ff4c343a 100644 --- a/docs/command/atlas-api-teams-renameTeam.txt +++ b/docs/command/atlas-api-teams-renameTeam.txt @@ -14,6 +14,9 @@ atlas api teams renameTeam Renames one team in the specified organization. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. 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-renameteam. diff --git a/docs/command/atlas-api-teams-updateTeamRoles.txt b/docs/command/atlas-api-teams-updateTeamRoles.txt index ad2e4f02a7..de0c41af4e 100644 --- a/docs/command/atlas-api-teams-updateTeamRoles.txt +++ b/docs/command/atlas-api-teams-updateTeamRoles.txt @@ -14,6 +14,9 @@ atlas api teams updateTeamRoles Updates the project roles assigned to the specified team. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Owner role. 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-updateteamroles. diff --git a/docs/command/atlas-api-teams.txt b/docs/command/atlas-api-teams.txt index 33798fd9e7..84f2bb1077 100644 --- a/docs/command/atlas-api-teams.txt +++ b/docs/command/atlas-api-teams.txt @@ -14,6 +14,11 @@ atlas api teams Returns, adds, edits, or removes teams. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + + + Options ------- diff --git a/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt index 5d2a05b746..c9e7b3f3d7 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt @@ -14,6 +14,9 @@ atlas api thirdPartyIntegrations createThirdPartyIntegration Adds the settings for configuring one third-party service integration. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + These settings apply to all databases managed in the specified MongoDB Cloud project. Each project can have only one configuration per {INTEGRATION-TYPE}. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. 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-createthirdpartyintegration. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt index 69b3c10a91..8eaeb5bb73 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt @@ -14,6 +14,9 @@ atlas api thirdPartyIntegrations deleteThirdPartyIntegration Removes the settings that permit configuring one third-party service integration. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured {INTEGRATION-TYPE} integrations. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. 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-deletethirdpartyintegration. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt index 0329ffd94f..c6b87ae1cc 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt @@ -14,6 +14,9 @@ atlas api thirdPartyIntegrations getThirdPartyIntegration Returns the settings for configuring integration with one third-party service. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. 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-getthirdpartyintegration. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt index 29fad23bd6..090c2bf614 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt @@ -14,6 +14,9 @@ atlas api thirdPartyIntegrations listThirdPartyIntegrations Returns the settings that permit integrations with all configured third-party services. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. 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-listthirdpartyintegrations. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt index 92bb8e453e..bcc8c5329e 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt @@ -14,6 +14,9 @@ atlas api thirdPartyIntegrations updateThirdPartyIntegration Updates the settings for configuring integration with one third-party service. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. 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-updatethirdpartyintegration. diff --git a/docs/command/atlas-api-thirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations.txt index af79740965..b92814a915 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations.txt @@ -14,6 +14,9 @@ atlas api thirdPartyIntegrations Returns, adds, edits, and removes third-party service integration configurations. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + MongoDB Cloud sends alerts to each third-party service that you configure. diff --git a/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt b/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt index 6a89fd6729..a8753c3010 100644 --- a/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt +++ b/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt @@ -14,6 +14,9 @@ atlas api x509Authentication createDatabaseUserCertificate Generates one X.509 certificate for the specified MongoDB user. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt b/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt index aa8b3d3e15..10804db52f 100644 --- a/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt +++ b/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt @@ -14,6 +14,9 @@ atlas api x509Authentication disableCustomerManagedX509 Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint. 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-disablecustomermanagedx509. diff --git a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt b/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt index 992049864d..6cb3444da6 100644 --- a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt +++ b/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt @@ -14,6 +14,9 @@ atlas api x509Authentication listDatabaseUserCertificates Returns all unexpired X.509 certificates for the specified MongoDB user. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. 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-listdatabaseusercertificates. diff --git a/docs/command/atlas-api-x509Authentication.txt b/docs/command/atlas-api-x509Authentication.txt index 4ca597d0be..2d8e940966 100644 --- a/docs/command/atlas-api-x509Authentication.txt +++ b/docs/command/atlas-api-x509Authentication.txt @@ -14,6 +14,9 @@ atlas api x509Authentication Returns, edits, and removes user-managed X.509 configurations. +The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. + Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users. Options diff --git a/tools/cmd/docs/transformations.go b/tools/cmd/docs/transformations.go index c68c61b225..b24e59c2bb 100644 --- a/tools/cmd/docs/transformations.go +++ b/tools/cmd/docs/transformations.go @@ -24,6 +24,7 @@ import ( "strconv" "strings" + "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli" pluginCmd "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli/plugin" "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/plugin" "github.com/mongodb/mongodb-atlas-cli/atlascli/tools/internal/metadatatypes" @@ -56,6 +57,13 @@ func setDisableAutoGenTag(cmd *cobra.Command) { cmd.DisableAutoGenTag = true } +func markAPICommands(cmd *cobra.Command) { + if cmd.CommandPath() == "atlas api" { + return // Skip the root command + } + cmd.Long = cli.APICommandText + cmd.Long +} + func updateAPICommandDescription(cmd *cobra.Command) { if len(cmd.Commands()) > 0 { return @@ -276,6 +284,7 @@ func applyTransformations(cmd *cobra.Command) error { if isAPICommand(cmd) { removeCommandsWithOnlyPrivatePreview(cmd) + markAPICommands(cmd) updateAPICommandDescription(cmd) if err := updateExamples(cmd); err != nil { return err From eb0281d51546d7a8312fc709a635706263c286e1 Mon Sep 17 00:00:00 2001 From: Luke Sanderson Date: Fri, 26 Sep 2025 13:47:45 +0100 Subject: [PATCH 08/11] PR suggestion --- .../atlas-api-accessTracking-listAccessLogsByClusterName.txt | 2 +- .../atlas-api-accessTracking-listAccessLogsByHostname.txt | 2 +- docs/command/atlas-api-accessTracking.txt | 2 +- ...atlas-api-alertConfigurations-createAlertConfiguration.txt | 2 +- ...atlas-api-alertConfigurations-deleteAlertConfiguration.txt | 2 +- .../atlas-api-alertConfigurations-getAlertConfiguration.txt | 2 +- ...onfigurations-listAlertConfigurationMatchersFieldNames.txt | 2 +- .../atlas-api-alertConfigurations-listAlertConfigurations.txt | 2 +- ...i-alertConfigurations-listAlertConfigurationsByAlertId.txt | 2 +- ...atlas-api-alertConfigurations-toggleAlertConfiguration.txt | 2 +- ...atlas-api-alertConfigurations-updateAlertConfiguration.txt | 2 +- docs/command/atlas-api-alertConfigurations.txt | 2 +- docs/command/atlas-api-alerts-acknowledgeAlert.txt | 2 +- docs/command/atlas-api-alerts-getAlert.txt | 2 +- docs/command/atlas-api-alerts-listAlerts.txt | 2 +- .../atlas-api-alerts-listAlertsByAlertConfigurationId.txt | 2 +- docs/command/atlas-api-alerts.txt | 2 +- .../atlas-api-atlasSearch-createAtlasSearchDeployment.txt | 2 +- docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt | 2 +- ...atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt | 2 +- .../atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt | 2 +- docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt | 2 +- .../atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt | 2 +- ...atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt | 2 +- .../atlas-api-atlasSearch-getAtlasSearchDeployment.txt | 2 +- docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt | 2 +- .../atlas-api-atlasSearch-getAtlasSearchIndexByName.txt | 2 +- .../atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt | 2 +- docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt | 2 +- .../atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt | 2 +- ...atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt | 2 +- .../atlas-api-atlasSearch-updateAtlasSearchDeployment.txt | 2 +- docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt | 2 +- .../atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt | 2 +- ...atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt | 2 +- docs/command/atlas-api-atlasSearch.txt | 2 +- docs/command/atlas-api-auditing-getAuditingConfiguration.txt | 2 +- .../atlas-api-auditing-updateAuditingConfiguration.txt | 2 +- docs/command/atlas-api-auditing.txt | 2 +- docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt | 2 +- docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt | 2 +- docs/command/atlas-api-awsClustersDns.txt | 2 +- .../command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt | 2 +- docs/command/atlas-api-cloudBackups-createBackupExportJob.txt | 2 +- .../command/atlas-api-cloudBackups-createBackupRestoreJob.txt | 2 +- docs/command/atlas-api-cloudBackups-createExportBucket.txt | 2 +- ...tlas-api-cloudBackups-createServerlessBackupRestoreJob.txt | 2 +- .../atlas-api-cloudBackups-deleteAllBackupSchedules.txt | 2 +- docs/command/atlas-api-cloudBackups-deleteExportBucket.txt | 2 +- .../command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt | 2 +- .../atlas-api-cloudBackups-deleteShardedClusterBackup.txt | 2 +- .../atlas-api-cloudBackups-disableDataProtectionSettings.txt | 2 +- docs/command/atlas-api-cloudBackups-getBackupExportJob.txt | 2 +- docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt | 2 +- docs/command/atlas-api-cloudBackups-getBackupSchedule.txt | 2 +- .../atlas-api-cloudBackups-getDataProtectionSettings.txt | 2 +- docs/command/atlas-api-cloudBackups-getExportBucket.txt | 2 +- docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt | 2 +- docs/command/atlas-api-cloudBackups-getServerlessBackup.txt | 2 +- .../atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt | 2 +- .../atlas-api-cloudBackups-getShardedClusterBackup.txt | 2 +- docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt | 2 +- docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt | 2 +- docs/command/atlas-api-cloudBackups-listExportBuckets.txt | 2 +- docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt | 2 +- ...atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt | 2 +- docs/command/atlas-api-cloudBackups-listServerlessBackups.txt | 2 +- .../atlas-api-cloudBackups-listShardedClusterBackups.txt | 2 +- docs/command/atlas-api-cloudBackups-takeSnapshot.txt | 2 +- docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt | 2 +- .../atlas-api-cloudBackups-updateDataProtectionSettings.txt | 2 +- .../atlas-api-cloudBackups-updateSnapshotRetention.txt | 2 +- docs/command/atlas-api-cloudBackups.txt | 2 +- .../atlas-api-cloudMigrationService-createLinkToken.txt | 2 +- .../atlas-api-cloudMigrationService-createPushMigration.txt | 2 +- .../atlas-api-cloudMigrationService-cutoverMigration.txt | 2 +- .../atlas-api-cloudMigrationService-deleteLinkToken.txt | 2 +- .../atlas-api-cloudMigrationService-getPushMigration.txt | 2 +- .../atlas-api-cloudMigrationService-getValidationStatus.txt | 2 +- .../atlas-api-cloudMigrationService-listSourceProjects.txt | 2 +- .../atlas-api-cloudMigrationService-validateMigration.txt | 2 +- docs/command/atlas-api-cloudMigrationService.txt | 2 +- ...i-cloudProviderAccess-authorizeCloudProviderAccessRole.txt | 2 +- ...-api-cloudProviderAccess-createCloudProviderAccessRole.txt | 2 +- ...cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt | 2 +- ...las-api-cloudProviderAccess-getCloudProviderAccessRole.txt | 2 +- ...s-api-cloudProviderAccess-listCloudProviderAccessRoles.txt | 2 +- docs/command/atlas-api-cloudProviderAccess.txt | 2 +- .../atlas-api-clusterOutageSimulation-endOutageSimulation.txt | 2 +- .../atlas-api-clusterOutageSimulation-getOutageSimulation.txt | 2 +- ...tlas-api-clusterOutageSimulation-startOutageSimulation.txt | 2 +- docs/command/atlas-api-clusterOutageSimulation.txt | 2 +- docs/command/atlas-api-clusters-autoScalingConfiguration.txt | 2 +- docs/command/atlas-api-clusters-createCluster.txt | 2 +- docs/command/atlas-api-clusters-deleteCluster.txt | 2 +- docs/command/atlas-api-clusters-getCluster.txt | 2 +- .../atlas-api-clusters-getClusterAdvancedConfiguration.txt | 2 +- docs/command/atlas-api-clusters-getClusterStatus.txt | 2 +- .../command/atlas-api-clusters-getSampleDatasetLoadStatus.txt | 2 +- .../command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt | 2 +- docs/command/atlas-api-clusters-listCloudProviderRegions.txt | 2 +- docs/command/atlas-api-clusters-listClusters.txt | 2 +- .../command/atlas-api-clusters-listClustersForAllProjects.txt | 2 +- docs/command/atlas-api-clusters-loadSampleDataset.txt | 2 +- .../atlas-api-clusters-pinFeatureCompatibilityVersion.txt | 2 +- .../atlas-api-clusters-revokeMongoDbEmployeeAccess.txt | 2 +- docs/command/atlas-api-clusters-testFailover.txt | 2 +- .../atlas-api-clusters-unpinFeatureCompatibilityVersion.txt | 2 +- docs/command/atlas-api-clusters-updateCluster.txt | 2 +- .../atlas-api-clusters-updateClusterAdvancedConfiguration.txt | 2 +- docs/command/atlas-api-clusters-upgradeSharedCluster.txt | 2 +- docs/command/atlas-api-clusters.txt | 2 +- ...etrics-getCollStatsLatencyNamespaceClusterMeasurements.txt | 2 +- ...elMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt | 2 +- ...ectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt | 2 +- ...onLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt | 2 +- ...ctionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt | 2 +- .../atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt | 2 +- .../atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt | 2 +- .../atlas-api-collectionLevelMetrics-pinNamespacesPut.txt | 2 +- .../atlas-api-collectionLevelMetrics-unpinNamespaces.txt | 2 +- docs/command/atlas-api-collectionLevelMetrics.txt | 2 +- ...atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt | 2 +- ...atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt | 2 +- .../atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt | 2 +- .../atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt | 2 +- ...atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt | 2 +- docs/command/atlas-api-customDatabaseRoles.txt | 2 +- ...api-dataFederation-createDataFederationPrivateEndpoint.txt | 2 +- .../atlas-api-dataFederation-createFederatedDatabase.txt | 2 +- ...s-api-dataFederation-createOneDataFederationQueryLimit.txt | 2 +- ...api-dataFederation-deleteDataFederationPrivateEndpoint.txt | 2 +- .../atlas-api-dataFederation-deleteFederatedDatabase.txt | 2 +- ...taFederation-deleteOneDataFederationInstanceQueryLimit.txt | 2 +- ...-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt | 2 +- ...as-api-dataFederation-getDataFederationPrivateEndpoint.txt | 2 +- .../command/atlas-api-dataFederation-getFederatedDatabase.txt | 2 +- ...-api-dataFederation-listDataFederationPrivateEndpoints.txt | 2 +- .../atlas-api-dataFederation-listFederatedDatabases.txt | 2 +- ...s-api-dataFederation-returnFederatedDatabaseQueryLimit.txt | 2 +- ...-api-dataFederation-returnFederatedDatabaseQueryLimits.txt | 2 +- .../atlas-api-dataFederation-updateFederatedDatabase.txt | 2 +- docs/command/atlas-api-dataFederation.txt | 2 +- docs/command/atlas-api-databaseUsers-createDatabaseUser.txt | 2 +- docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt | 2 +- docs/command/atlas-api-databaseUsers-getDatabaseUser.txt | 2 +- docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt | 2 +- docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt | 2 +- docs/command/atlas-api-databaseUsers.txt | 2 +- ...merKeyManagement-createEncryptionAtRestPrivateEndpoint.txt | 2 +- ...onAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt | 2 +- ...stomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt | 2 +- ...nt-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt | 2 +- ...agement-requestEncryptionAtRestPrivateEndpointDeletion.txt | 2 +- ...tRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt | 2 +- .../atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt | 2 +- docs/command/atlas-api-events-getOrganizationEvent.txt | 2 +- docs/command/atlas-api-events-getProjectEvent.txt | 2 +- docs/command/atlas-api-events-listEventTypes.txt | 2 +- docs/command/atlas-api-events-listOrganizationEvents.txt | 2 +- docs/command/atlas-api-events-listProjectEvents.txt | 2 +- docs/command/atlas-api-events.txt | 2 +- ...las-api-federatedAuthentication-createIdentityProvider.txt | 2 +- .../atlas-api-federatedAuthentication-createRoleMapping.txt | 2 +- .../atlas-api-federatedAuthentication-deleteFederationApp.txt | 2 +- ...las-api-federatedAuthentication-deleteIdentityProvider.txt | 2 +- .../atlas-api-federatedAuthentication-deleteRoleMapping.txt | 2 +- ...tlas-api-federatedAuthentication-getConnectedOrgConfig.txt | 2 +- ...tlas-api-federatedAuthentication-getFederationSettings.txt | 2 +- .../atlas-api-federatedAuthentication-getIdentityProvider.txt | 2 +- ...pi-federatedAuthentication-getIdentityProviderMetadata.txt | 2 +- .../atlas-api-federatedAuthentication-getRoleMapping.txt | 2 +- ...as-api-federatedAuthentication-listConnectedOrgConfigs.txt | 2 +- ...tlas-api-federatedAuthentication-listIdentityProviders.txt | 2 +- .../atlas-api-federatedAuthentication-listRoleMappings.txt | 2 +- ...s-api-federatedAuthentication-removeConnectedOrgConfig.txt | 2 +- ...federatedAuthentication-revokeJwksFromIdentityProvider.txt | 2 +- ...s-api-federatedAuthentication-updateConnectedOrgConfig.txt | 2 +- ...las-api-federatedAuthentication-updateIdentityProvider.txt | 2 +- .../atlas-api-federatedAuthentication-updateRoleMapping.txt | 2 +- docs/command/atlas-api-federatedAuthentication.txt | 2 +- docs/command/atlas-api-flexClusters-createFlexCluster.txt | 2 +- docs/command/atlas-api-flexClusters-deleteFlexCluster.txt | 2 +- docs/command/atlas-api-flexClusters-getFlexCluster.txt | 2 +- docs/command/atlas-api-flexClusters-listFlexClusters.txt | 2 +- docs/command/atlas-api-flexClusters-updateFlexCluster.txt | 2 +- docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt | 2 +- docs/command/atlas-api-flexClusters.txt | 2 +- .../atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt | 2 +- .../atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt | 2 +- .../atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt | 2 +- docs/command/atlas-api-flexRestoreJobs.txt | 2 +- docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt | 2 +- docs/command/atlas-api-flexSnapshots-getFlexBackup.txt | 2 +- docs/command/atlas-api-flexSnapshots-listFlexBackups.txt | 2 +- docs/command/atlas-api-flexSnapshots.txt | 2 +- .../atlas-api-globalClusters-createCustomZoneMapping.txt | 2 +- .../atlas-api-globalClusters-createManagedNamespace.txt | 2 +- .../atlas-api-globalClusters-deleteAllCustomZoneMappings.txt | 2 +- .../atlas-api-globalClusters-deleteManagedNamespace.txt | 2 +- docs/command/atlas-api-globalClusters-getManagedNamespace.txt | 2 +- docs/command/atlas-api-globalClusters.txt | 2 +- .../atlas-api-invoices-createCostExplorerQueryProcess.txt | 2 +- docs/command/atlas-api-invoices-downloadInvoiceCsv.txt | 2 +- .../atlas-api-invoices-getCostExplorerQueryProcess.txt | 2 +- docs/command/atlas-api-invoices-getInvoice.txt | 2 +- docs/command/atlas-api-invoices-listInvoices.txt | 2 +- docs/command/atlas-api-invoices-listPendingInvoices.txt | 2 +- .../atlas-api-invoices-queryLineItemsFromSingleInvoice.txt | 2 +- docs/command/atlas-api-invoices.txt | 2 +- .../atlas-api-ldapConfiguration-deleteLdapConfiguration.txt | 2 +- .../atlas-api-ldapConfiguration-getLdapConfiguration.txt | 2 +- ...atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt | 2 +- .../atlas-api-ldapConfiguration-saveLdapConfiguration.txt | 2 +- .../atlas-api-ldapConfiguration-verifyLdapConfiguration.txt | 2 +- docs/command/atlas-api-ldapConfiguration.txt | 2 +- .../atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt | 2 +- docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt | 2 +- .../atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt | 2 +- .../atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt | 2 +- docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt | 2 +- .../atlas-api-legacyBackup-getLegacySnapshotSchedule.txt | 2 +- .../atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt | 2 +- .../atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt | 2 +- docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt | 2 +- .../atlas-api-legacyBackup-updateLegacySnapshotRetention.txt | 2 +- .../atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt | 2 +- docs/command/atlas-api-legacyBackup.txt | 2 +- .../atlas-api-maintenanceWindows-deferMaintenanceWindow.txt | 2 +- .../atlas-api-maintenanceWindows-getMaintenanceWindow.txt | 2 +- .../atlas-api-maintenanceWindows-resetMaintenanceWindow.txt | 2 +- ...tlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt | 2 +- .../atlas-api-maintenanceWindows-updateMaintenanceWindow.txt | 2 +- docs/command/atlas-api-maintenanceWindows.txt | 2 +- .../atlas-api-mongoDbCloudUsers-addOrganizationRole.txt | 2 +- docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt | 2 +- docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt | 2 +- docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt | 2 +- .../atlas-api-mongoDbCloudUsers-createOrganizationUser.txt | 2 +- docs/command/atlas-api-mongoDbCloudUsers-createUser.txt | 2 +- .../atlas-api-mongoDbCloudUsers-getOrganizationUser.txt | 2 +- docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt | 2 +- docs/command/atlas-api-mongoDbCloudUsers-getUser.txt | 2 +- .../command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt | 2 +- .../atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt | 2 +- docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt | 2 +- docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt | 2 +- .../atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt | 2 +- .../atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt | 2 +- .../command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt | 2 +- .../command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt | 2 +- .../atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt | 2 +- .../atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt | 2 +- docs/command/atlas-api-mongoDbCloudUsers.txt | 2 +- docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt | 2 +- docs/command/atlas-api-monitoringAndLogs-getDatabase.txt | 2 +- .../atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt | 2 +- .../atlas-api-monitoringAndLogs-getDiskMeasurements.txt | 2 +- docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt | 2 +- .../atlas-api-monitoringAndLogs-getHostMeasurements.txt | 2 +- docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt | 2 +- docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt | 2 +- .../atlas-api-monitoringAndLogs-listAtlasProcesses.txt | 2 +- docs/command/atlas-api-monitoringAndLogs-listDatabases.txt | 2 +- .../atlas-api-monitoringAndLogs-listDiskMeasurements.txt | 2 +- .../atlas-api-monitoringAndLogs-listDiskPartitions.txt | 2 +- docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt | 2 +- docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt | 2 +- docs/command/atlas-api-monitoringAndLogs.txt | 2 +- .../atlas-api-networkPeering-createPeeringConnection.txt | 2 +- .../atlas-api-networkPeering-createPeeringContainer.txt | 2 +- .../atlas-api-networkPeering-deletePeeringConnection.txt | 2 +- .../atlas-api-networkPeering-deletePeeringContainer.txt | 2 +- docs/command/atlas-api-networkPeering-disablePeering.txt | 2 +- .../command/atlas-api-networkPeering-getPeeringConnection.txt | 2 +- docs/command/atlas-api-networkPeering-getPeeringContainer.txt | 2 +- .../atlas-api-networkPeering-listPeeringConnections.txt | 2 +- ...api-networkPeering-listPeeringContainerByCloudProvider.txt | 2 +- .../atlas-api-networkPeering-listPeeringContainers.txt | 2 +- .../atlas-api-networkPeering-updatePeeringConnection.txt | 2 +- .../atlas-api-networkPeering-updatePeeringContainer.txt | 2 +- ...rkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt | 2 +- docs/command/atlas-api-networkPeering.txt | 2 +- docs/command/atlas-api-onlineArchive-createOnlineArchive.txt | 2 +- docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt | 2 +- ...atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt | 2 +- docs/command/atlas-api-onlineArchive-getOnlineArchive.txt | 2 +- docs/command/atlas-api-onlineArchive-listOnlineArchives.txt | 2 +- docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt | 2 +- docs/command/atlas-api-onlineArchive.txt | 2 +- docs/command/atlas-api-organizations-createOrganization.txt | 2 +- .../atlas-api-organizations-createOrganizationInvitation.txt | 2 +- docs/command/atlas-api-organizations-deleteOrganization.txt | 2 +- .../atlas-api-organizations-deleteOrganizationInvitation.txt | 2 +- docs/command/atlas-api-organizations-getOrganization.txt | 2 +- .../atlas-api-organizations-getOrganizationInvitation.txt | 2 +- .../atlas-api-organizations-getOrganizationSettings.txt | 2 +- .../atlas-api-organizations-listOrganizationInvitations.txt | 2 +- .../atlas-api-organizations-listOrganizationProjects.txt | 2 +- docs/command/atlas-api-organizations-listOrganizations.txt | 2 +- docs/command/atlas-api-organizations-updateOrganization.txt | 2 +- .../atlas-api-organizations-updateOrganizationInvitation.txt | 2 +- ...las-api-organizations-updateOrganizationInvitationById.txt | 2 +- .../atlas-api-organizations-updateOrganizationRoles.txt | 2 +- .../atlas-api-organizations-updateOrganizationSettings.txt | 2 +- docs/command/atlas-api-organizations.txt | 2 +- ...pi-performanceAdvisor-disableSlowOperationThresholding.txt | 2 +- ...api-performanceAdvisor-enableSlowOperationThresholding.txt | 2 +- .../command/atlas-api-performanceAdvisor-getManagedSlowMs.txt | 2 +- ...atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt | 2 +- ...las-api-performanceAdvisor-listClusterSuggestedIndexes.txt | 2 +- docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt | 2 +- .../command/atlas-api-performanceAdvisor-listSchemaAdvice.txt | 2 +- docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt | 2 +- .../atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt | 2 +- .../atlas-api-performanceAdvisor-listSuggestedIndexes.txt | 2 +- ...atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt | 2 +- docs/command/atlas-api-performanceAdvisor.txt | 2 +- ...tlas-api-privateEndpointServices-createPrivateEndpoint.txt | 2 +- ...i-privateEndpointServices-createPrivateEndpointService.txt | 2 +- ...tlas-api-privateEndpointServices-deletePrivateEndpoint.txt | 2 +- ...i-privateEndpointServices-deletePrivateEndpointService.txt | 2 +- .../atlas-api-privateEndpointServices-getPrivateEndpoint.txt | 2 +- ...-api-privateEndpointServices-getPrivateEndpointService.txt | 2 +- ...EndpointServices-getRegionalizedPrivateEndpointSetting.txt | 2 +- ...pi-privateEndpointServices-listPrivateEndpointServices.txt | 2 +- ...pointServices-toggleRegionalizedPrivateEndpointSetting.txt | 2 +- docs/command/atlas-api-privateEndpointServices.txt | 2 +- .../atlas-api-programmaticApiKeys-addProjectApiKey.txt | 2 +- docs/command/atlas-api-programmaticApiKeys-createApiKey.txt | 2 +- .../atlas-api-programmaticApiKeys-createApiKeyAccessList.txt | 2 +- .../atlas-api-programmaticApiKeys-createProjectApiKey.txt | 2 +- docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt | 2 +- ...as-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt | 2 +- docs/command/atlas-api-programmaticApiKeys-getApiKey.txt | 2 +- .../atlas-api-programmaticApiKeys-getApiKeyAccessList.txt | 2 +- ...s-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt | 2 +- docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt | 2 +- .../atlas-api-programmaticApiKeys-listProjectApiKeys.txt | 2 +- .../atlas-api-programmaticApiKeys-removeProjectApiKey.txt | 2 +- docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt | 2 +- .../atlas-api-programmaticApiKeys-updateApiKeyRoles.txt | 2 +- docs/command/atlas-api-programmaticApiKeys.txt | 2 +- ...tlas-api-projectIpAccessList-createProjectIpAccessList.txt | 2 +- ...tlas-api-projectIpAccessList-deleteProjectIpAccessList.txt | 2 +- ...s-api-projectIpAccessList-getProjectIpAccessListStatus.txt | 2 +- .../atlas-api-projectIpAccessList-getProjectIpList.txt | 2 +- ...atlas-api-projectIpAccessList-listProjectIpAccessLists.txt | 2 +- docs/command/atlas-api-projectIpAccessList.txt | 2 +- docs/command/atlas-api-projects-addUserToProject.txt | 2 +- docs/command/atlas-api-projects-createProject.txt | 2 +- docs/command/atlas-api-projects-createProjectInvitation.txt | 2 +- docs/command/atlas-api-projects-deleteProject.txt | 2 +- docs/command/atlas-api-projects-deleteProjectInvitation.txt | 2 +- docs/command/atlas-api-projects-deleteProjectLimit.txt | 2 +- docs/command/atlas-api-projects-getProject.txt | 2 +- docs/command/atlas-api-projects-getProjectByName.txt | 2 +- docs/command/atlas-api-projects-getProjectInvitation.txt | 2 +- docs/command/atlas-api-projects-getProjectLimit.txt | 2 +- docs/command/atlas-api-projects-getProjectLtsVersions.txt | 2 +- docs/command/atlas-api-projects-getProjectSettings.txt | 2 +- docs/command/atlas-api-projects-listProjectInvitations.txt | 2 +- docs/command/atlas-api-projects-listProjectLimits.txt | 2 +- docs/command/atlas-api-projects-listProjects.txt | 2 +- .../command/atlas-api-projects-migrateProjectToAnotherOrg.txt | 2 +- docs/command/atlas-api-projects-returnAllIpAddresses.txt | 2 +- docs/command/atlas-api-projects-setProjectLimit.txt | 2 +- docs/command/atlas-api-projects-updateProject.txt | 2 +- docs/command/atlas-api-projects-updateProjectInvitation.txt | 2 +- .../atlas-api-projects-updateProjectInvitationById.txt | 2 +- docs/command/atlas-api-projects-updateProjectRoles.txt | 2 +- docs/command/atlas-api-projects-updateProjectSettings.txt | 2 +- docs/command/atlas-api-projects.txt | 2 +- ...api-pushBasedLogExport-createPushBasedLogConfiguration.txt | 2 +- ...api-pushBasedLogExport-deletePushBasedLogConfiguration.txt | 2 +- ...as-api-pushBasedLogExport-getPushBasedLogConfiguration.txt | 2 +- ...api-pushBasedLogExport-updatePushBasedLogConfiguration.txt | 2 +- docs/command/atlas-api-pushBasedLogExport.txt | 2 +- ...yShapeInsights-getGroupClusterQueryShapeInsightDetails.txt | 2 +- ...hapeInsights-getGroupClusterQueryShapeInsightSummaries.txt | 2 +- docs/command/atlas-api-queryShapeInsights.txt | 2 +- .../atlas-api-resourcePolicies-createOrgResourcePolicy.txt | 2 +- .../atlas-api-resourcePolicies-deleteOrgResourcePolicy.txt | 2 +- .../atlas-api-resourcePolicies-getOrgResourcePolicy.txt | 2 +- .../atlas-api-resourcePolicies-getResourcesNonCompliant.txt | 2 +- .../atlas-api-resourcePolicies-listOrgResourcePolicies.txt | 2 +- .../atlas-api-resourcePolicies-updateOrgResourcePolicy.txt | 2 +- ...atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt | 2 +- docs/command/atlas-api-resourcePolicies.txt | 2 +- docs/command/atlas-api-rollingIndex-createRollingIndex.txt | 2 +- docs/command/atlas-api-rollingIndex.txt | 2 +- docs/command/atlas-api-root-getSystemStatus.txt | 2 +- .../atlas-api-root-returnAllControlPlaneIpAddresses.txt | 2 +- docs/command/atlas-api-root.txt | 2 +- ...atlas-api-serverlessInstances-createServerlessInstance.txt | 2 +- ...atlas-api-serverlessInstances-deleteServerlessInstance.txt | 2 +- .../atlas-api-serverlessInstances-getServerlessInstance.txt | 2 +- .../atlas-api-serverlessInstances-listServerlessInstances.txt | 2 +- ...atlas-api-serverlessInstances-updateServerlessInstance.txt | 2 +- docs/command/atlas-api-serverlessInstances.txt | 2 +- ...erlessPrivateEndpoints-createServerlessPrivateEndpoint.txt | 2 +- ...erlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt | 2 +- ...erverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt | 2 +- ...verlessPrivateEndpoints-listServerlessPrivateEndpoints.txt | 2 +- ...erlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt | 2 +- docs/command/atlas-api-serverlessPrivateEndpoints.txt | 2 +- .../atlas-api-serviceAccounts-addProjectServiceAccount.txt | 2 +- .../atlas-api-serviceAccounts-createProjectServiceAccount.txt | 2 +- ...-serviceAccounts-createProjectServiceAccountAccessList.txt | 2 +- ...-api-serviceAccounts-createProjectServiceAccountSecret.txt | 2 +- .../atlas-api-serviceAccounts-createServiceAccount.txt | 2 +- ...las-api-serviceAccounts-createServiceAccountAccessList.txt | 2 +- .../atlas-api-serviceAccounts-createServiceAccountSecret.txt | 2 +- .../atlas-api-serviceAccounts-deleteProjectServiceAccount.txt | 2 +- ...iceAccounts-deleteProjectServiceAccountAccessListEntry.txt | 2 +- ...-api-serviceAccounts-deleteProjectServiceAccountSecret.txt | 2 +- .../atlas-api-serviceAccounts-deleteServiceAccount.txt | 2 +- ...pi-serviceAccounts-deleteServiceAccountAccessListEntry.txt | 2 +- .../atlas-api-serviceAccounts-deleteServiceAccountSecret.txt | 2 +- .../atlas-api-serviceAccounts-getProjectServiceAccount.txt | 2 +- docs/command/atlas-api-serviceAccounts-getServiceAccount.txt | 2 +- ...pi-serviceAccounts-listProjectServiceAccountAccessList.txt | 2 +- .../atlas-api-serviceAccounts-listProjectServiceAccounts.txt | 2 +- ...atlas-api-serviceAccounts-listServiceAccountAccessList.txt | 2 +- .../atlas-api-serviceAccounts-listServiceAccountProjects.txt | 2 +- .../command/atlas-api-serviceAccounts-listServiceAccounts.txt | 2 +- .../atlas-api-serviceAccounts-updateProjectServiceAccount.txt | 2 +- .../atlas-api-serviceAccounts-updateServiceAccount.txt | 2 +- docs/command/atlas-api-serviceAccounts.txt | 2 +- ...redTierRestoreJobs-createSharedClusterBackupRestoreJob.txt | 2 +- ...sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt | 2 +- ...aredTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt | 2 +- docs/command/atlas-api-sharedTierRestoreJobs.txt | 2 +- ...as-api-sharedTierSnapshots-downloadSharedClusterBackup.txt | 2 +- .../atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt | 2 +- ...atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt | 2 +- docs/command/atlas-api-sharedTierSnapshots.txt | 2 +- docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt | 2 +- .../command/atlas-api-streams-createPrivateLinkConnection.txt | 2 +- docs/command/atlas-api-streams-createStreamConnection.txt | 2 +- docs/command/atlas-api-streams-createStreamInstance.txt | 2 +- ...-api-streams-createStreamInstanceWithSampleConnections.txt | 2 +- docs/command/atlas-api-streams-createStreamProcessor.txt | 2 +- .../command/atlas-api-streams-deletePrivateLinkConnection.txt | 2 +- docs/command/atlas-api-streams-deleteStreamConnection.txt | 2 +- docs/command/atlas-api-streams-deleteStreamInstance.txt | 2 +- docs/command/atlas-api-streams-deleteStreamProcessor.txt | 2 +- docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt | 2 +- .../atlas-api-streams-downloadStreamTenantAuditLogs.txt | 2 +- docs/command/atlas-api-streams-getAccountDetails.txt | 2 +- .../atlas-api-streams-getActiveVpcPeeringConnections.txt | 2 +- docs/command/atlas-api-streams-getPrivateLinkConnection.txt | 2 +- docs/command/atlas-api-streams-getStreamConnection.txt | 2 +- docs/command/atlas-api-streams-getStreamInstance.txt | 2 +- docs/command/atlas-api-streams-getStreamProcessor.txt | 2 +- docs/command/atlas-api-streams-getVpcPeeringConnections.txt | 2 +- docs/command/atlas-api-streams-listPrivateLinkConnections.txt | 2 +- docs/command/atlas-api-streams-listStreamConnections.txt | 2 +- docs/command/atlas-api-streams-listStreamInstances.txt | 2 +- docs/command/atlas-api-streams-listStreamProcessors.txt | 2 +- docs/command/atlas-api-streams-modifyStreamProcessor.txt | 2 +- docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt | 2 +- docs/command/atlas-api-streams-startStreamProcessor.txt | 2 +- docs/command/atlas-api-streams-startStreamProcessorWith.txt | 2 +- docs/command/atlas-api-streams-stopStreamProcessor.txt | 2 +- docs/command/atlas-api-streams-updateStreamConnection.txt | 2 +- docs/command/atlas-api-streams-updateStreamInstance.txt | 2 +- docs/command/atlas-api-streams.txt | 2 +- docs/command/atlas-api-teams-addAllTeamsToProject.txt | 2 +- docs/command/atlas-api-teams-addTeamUser.txt | 2 +- docs/command/atlas-api-teams-createTeam.txt | 2 +- docs/command/atlas-api-teams-deleteTeam.txt | 2 +- docs/command/atlas-api-teams-getProjectTeam.txt | 2 +- docs/command/atlas-api-teams-getTeamById.txt | 2 +- docs/command/atlas-api-teams-getTeamByName.txt | 2 +- docs/command/atlas-api-teams-listOrganizationTeams.txt | 2 +- docs/command/atlas-api-teams-listProjectTeams.txt | 2 +- docs/command/atlas-api-teams-removeProjectTeam.txt | 2 +- docs/command/atlas-api-teams-removeTeamUser.txt | 2 +- docs/command/atlas-api-teams-renameTeam.txt | 2 +- docs/command/atlas-api-teams-updateTeamRoles.txt | 2 +- docs/command/atlas-api-teams.txt | 2 +- ...api-thirdPartyIntegrations-createThirdPartyIntegration.txt | 2 +- ...api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt | 2 +- ...as-api-thirdPartyIntegrations-getThirdPartyIntegration.txt | 2 +- ...-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt | 2 +- ...api-thirdPartyIntegrations-updateThirdPartyIntegration.txt | 2 +- docs/command/atlas-api-thirdPartyIntegrations.txt | 2 +- ...s-api-x509Authentication-createDatabaseUserCertificate.txt | 2 +- ...tlas-api-x509Authentication-disableCustomerManagedX509.txt | 2 +- ...as-api-x509Authentication-listDatabaseUserCertificates.txt | 2 +- docs/command/atlas-api-x509Authentication.txt | 2 +- docs/command/atlas-api.txt | 2 +- internal/cli/help_templates.go | 4 ++-- tools/cmd/docs/api_docs_long_text.txt | 2 +- 495 files changed, 496 insertions(+), 496 deletions(-) diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt index f4493dff77..008ff6f2ab 100644 --- a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt +++ b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt @@ -14,7 +14,7 @@ atlas api accessTracking listAccessLogsByClusterName Returns the access logs of one cluster identified by the cluster's name. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt index f19249e7c8..b2e8b01706 100644 --- a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt +++ b/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt @@ -14,7 +14,7 @@ atlas api accessTracking listAccessLogsByHostname Returns the access logs of one cluster identified by the cluster's hostname. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-accessTracking.txt b/docs/command/atlas-api-accessTracking.txt index 4ee573f23a..2f67464082 100644 --- a/docs/command/atlas-api-accessTracking.txt +++ b/docs/command/atlas-api-accessTracking.txt @@ -14,7 +14,7 @@ atlas api accessTracking Returns access logs for authentication attempts made to Atlas database deployments. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To view database access history, you must have either the Project Owner or Organization Owner role. diff --git a/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt index 5c24fe6204..846f0d34bd 100644 --- a/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt @@ -14,7 +14,7 @@ atlas api alertConfigurations createAlertConfiguration Creates one alert configuration for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt index 0ce8fd3b4b..6958629ee1 100644 --- a/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt @@ -14,7 +14,7 @@ atlas api alertConfigurations deleteAlertConfiguration Removes one alert configuration from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. diff --git a/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt index 4091f876b0..9f865f4679 100644 --- a/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt @@ -14,7 +14,7 @@ atlas api alertConfigurations getAlertConfiguration Returns the specified alert configuration from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt index 13a8527c8e..217de5dd48 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt @@ -14,7 +14,7 @@ atlas api alertConfigurations listAlertConfigurationMatchersFieldNames Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can successfully call this endpoint with any assigned role. diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt index da1f1138e7..545317bd51 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt @@ -14,7 +14,7 @@ atlas api alertConfigurations listAlertConfigurations Returns all alert configurations for one project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt index 81acc53c7f..8c56b01dc0 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt @@ -14,7 +14,7 @@ atlas api alertConfigurations listAlertConfigurationsByAlertId Returns all alert configurations set for the specified alert. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. diff --git a/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt index 74400a1f09..28d89dc6d1 100644 --- a/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt @@ -14,7 +14,7 @@ atlas api alertConfigurations toggleAlertConfiguration Enables or disables the specified alert configuration in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. diff --git a/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt index 255ca50863..77ac0990bd 100644 --- a/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt @@ -14,7 +14,7 @@ atlas api alertConfigurations updateAlertConfiguration Updates one alert configuration in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-alertConfigurations.txt b/docs/command/atlas-api-alertConfigurations.txt index 0156575795..1bdc8c7444 100644 --- a/docs/command/atlas-api-alertConfigurations.txt +++ b/docs/command/atlas-api-alertConfigurations.txt @@ -14,7 +14,7 @@ atlas api alertConfigurations Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This collection remains under revision and may change. diff --git a/docs/command/atlas-api-alerts-acknowledgeAlert.txt b/docs/command/atlas-api-alerts-acknowledgeAlert.txt index 4ac2ca830c..88b5b5f967 100644 --- a/docs/command/atlas-api-alerts-acknowledgeAlert.txt +++ b/docs/command/atlas-api-alerts-acknowledgeAlert.txt @@ -14,7 +14,7 @@ atlas api alerts acknowledgeAlert Confirms receipt of one existing alert. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. diff --git a/docs/command/atlas-api-alerts-getAlert.txt b/docs/command/atlas-api-alerts-getAlert.txt index 9371563310..a9463a0ac9 100644 --- a/docs/command/atlas-api-alerts-getAlert.txt +++ b/docs/command/atlas-api-alerts-getAlert.txt @@ -14,7 +14,7 @@ atlas api alerts getAlert Returns one alert. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access. diff --git a/docs/command/atlas-api-alerts-listAlerts.txt b/docs/command/atlas-api-alerts-listAlerts.txt index 96dd2e2dde..dabd1f0f41 100644 --- a/docs/command/atlas-api-alerts-listAlerts.txt +++ b/docs/command/atlas-api-alerts-listAlerts.txt @@ -14,7 +14,7 @@ atlas api alerts listAlerts Returns all alerts. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt b/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt index 58e84e5911..b24665d7d6 100644 --- a/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt +++ b/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt @@ -14,7 +14,7 @@ atlas api alerts listAlertsByAlertConfigurationId Returns all open alerts that the specified alert configuration triggers. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access. diff --git a/docs/command/atlas-api-alerts.txt b/docs/command/atlas-api-alerts.txt index 027a81d391..885e685819 100644 --- a/docs/command/atlas-api-alerts.txt +++ b/docs/command/atlas-api-alerts.txt @@ -14,7 +14,7 @@ atlas api alerts Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This collection remains under revision and may change. diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt index f36a8bce76..2d5206fea9 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt @@ -14,7 +14,7 @@ atlas api atlasSearch createAtlasSearchDeployment Creates Search Nodes for the specified cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-createatlassearchdeployment. diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt index e28884cbc8..cdaddb7c9c 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt @@ -14,7 +14,7 @@ atlas api atlasSearch createAtlasSearchIndex Creates one Atlas Search index on the specified collection. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt index b34cd1acd5..49038d86f1 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt @@ -14,7 +14,7 @@ atlas api atlasSearch createAtlasSearchIndexDeprecated Creates one Atlas Search index on the specified collection. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt index e162a2d316..54b4e5a48c 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt @@ -14,7 +14,7 @@ atlas api atlasSearch deleteAtlasSearchDeployment Deletes the Search Nodes for the specified cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-deleteatlassearchdeployment. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt index 44c38d2c31..c3e8f1f009 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt @@ -14,7 +14,7 @@ atlas api atlasSearch deleteAtlasSearchIndex Removes one Atlas Search index that you identified with its unique ID. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt index ef360863f2..cc5c62a82a 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt @@ -14,7 +14,7 @@ atlas api atlasSearch deleteAtlasSearchIndexByName Removes one Atlas Search index that you identified with its database, collection, and name. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt index 46cb34018b..37527bff3a 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt @@ -14,7 +14,7 @@ atlas api atlasSearch deleteAtlasSearchIndexDeprecated Removes one Atlas Search index that you identified with its unique ID. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt index 051da89bf3..73e131763a 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt @@ -14,7 +14,7 @@ atlas api atlasSearch getAtlasSearchDeployment Returns the Search Nodes for the specified cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getatlassearchdeployment. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt index 28db6b1647..4f6631c97b 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt @@ -14,7 +14,7 @@ atlas api atlasSearch getAtlasSearchIndex Returns one Atlas Search index that you identified with its unique ID. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt index d2de7dfe87..188e013daa 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt @@ -14,7 +14,7 @@ atlas api atlasSearch getAtlasSearchIndexByName Returns one Atlas Search index that you identified with its database, collection name, and index name. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt index 480fe655d3..1c25a400f4 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt @@ -14,7 +14,7 @@ atlas api atlasSearch getAtlasSearchIndexDeprecated Returns one Atlas Search index in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt index 53951080f9..ce41cdfd4d 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt @@ -14,7 +14,7 @@ atlas api atlasSearch listAtlasSearchIndexes Returns all Atlas Search indexes on the specified collection. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt index 78a4c11527..63068e8aaf 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt @@ -14,7 +14,7 @@ atlas api atlasSearch listAtlasSearchIndexesCluster Returns all Atlas Search indexes on the specified cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt index 751c1c8e23..5fd36ed7a0 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt @@ -14,7 +14,7 @@ atlas api atlasSearch listAtlasSearchIndexesDeprecated Returns all Atlas Search indexes on the specified collection. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt index f4db1b8fbe..57432cf1b3 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt @@ -14,7 +14,7 @@ atlas api atlasSearch updateAtlasSearchDeployment Updates the Search Nodes for the specified cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-updateatlassearchdeployment. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt index 0dd6f7a466..b685778861 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt @@ -14,7 +14,7 @@ atlas api atlasSearch updateAtlasSearchIndex Updates one Atlas Search index that you identified with its unique ID. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt index 47bb9b99e2..76e4fe01bd 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt @@ -14,7 +14,7 @@ atlas api atlasSearch updateAtlasSearchIndexByName Updates one Atlas Search index that you identified with its database, collection name, and index name. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt index 08dc989ab3..af233b034c 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt @@ -14,7 +14,7 @@ atlas api atlasSearch updateAtlasSearchIndexDeprecated Updates one Atlas Search index that you identified with its unique ID. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-atlasSearch.txt b/docs/command/atlas-api-atlasSearch.txt index 6d802f186a..e953495f54 100644 --- a/docs/command/atlas-api-atlasSearch.txt +++ b/docs/command/atlas-api-atlasSearch.txt @@ -14,7 +14,7 @@ atlas api atlasSearch Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Also returns and updates user-defined analyzers for the specified cluster. diff --git a/docs/command/atlas-api-auditing-getAuditingConfiguration.txt b/docs/command/atlas-api-auditing-getAuditingConfiguration.txt index 5225c8fa65..7d9dbbb1b0 100644 --- a/docs/command/atlas-api-auditing-getAuditingConfiguration.txt +++ b/docs/command/atlas-api-auditing-getAuditingConfiguration.txt @@ -14,7 +14,7 @@ atlas api auditing getAuditingConfiguration Returns the auditing configuration for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt b/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt index d766bfc435..200f66ff9d 100644 --- a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt +++ b/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt @@ -14,7 +14,7 @@ atlas api auditing updateAuditingConfiguration Updates the auditing configuration for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-auditing.txt b/docs/command/atlas-api-auditing.txt index b73bb08a23..afcd5a6880 100644 --- a/docs/command/atlas-api-auditing.txt +++ b/docs/command/atlas-api-auditing.txt @@ -14,7 +14,7 @@ atlas api auditing Returns and edits database auditing settings for MongoDB Cloud projects. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt b/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt index cdc6169d27..05fcb027aa 100644 --- a/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt +++ b/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt @@ -14,7 +14,7 @@ atlas api awsClustersDns getAwsCustomDns Returns the custom DNS configuration for AWS clusters in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt index f85fd1c6b5..89ed58e71a 100644 --- a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt +++ b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt @@ -14,7 +14,7 @@ atlas api awsClustersDns toggleAwsCustomDns Enables or disables the custom DNS configuration for AWS clusters in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Enable custom DNS if you use AWS VPC peering and use your own DNS servers. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. diff --git a/docs/command/atlas-api-awsClustersDns.txt b/docs/command/atlas-api-awsClustersDns.txt index 8c750a3c4e..0a73200799 100644 --- a/docs/command/atlas-api-awsClustersDns.txt +++ b/docs/command/atlas-api-awsClustersDns.txt @@ -14,7 +14,7 @@ atlas api awsClustersDns Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The resource requires your Project ID. If you use the VPC peering on AWS and you use your own DNS servers instead of Amazon Route 53, enable custom DNS. Before 31 March 2020, applications deployed within AWS using custom DNS services and VPC-peered with MongoDB Cloud couldn't connect over private IP addresses. Custom DNS resolved to public IP addresses. AWS internal DNS resolved to private IP addresses. Applications deployed with custom DNS services in AWS should use Private IP for Peering connection strings. diff --git a/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt index 1beadd9e6c..47e815646f 100644 --- a/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api cloudBackups cancelBackupRestoreJob Cancels one cloud backup restore job of one cluster from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt index 4f8a7e19b2..4df0b40a31 100644 --- a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt +++ b/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt @@ -14,7 +14,7 @@ atlas api cloudBackups createBackupExportJob Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. diff --git a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt index bd4d30534b..d262b5ee7e 100644 --- a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api cloudBackups createBackupRestoreJob Restores one snapshot of one cluster from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. diff --git a/docs/command/atlas-api-cloudBackups-createExportBucket.txt b/docs/command/atlas-api-cloudBackups-createExportBucket.txt index 2993b72546..1b402c778c 100644 --- a/docs/command/atlas-api-cloudBackups-createExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-createExportBucket.txt @@ -14,7 +14,7 @@ atlas api cloudBackups createExportBucket Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt index 204519bc6e..4d9c86ebe9 100644 --- a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api cloudBackups createServerlessBackupRestoreJob Restores one snapshot of one serverless instance from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt b/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt index 373f8bd8fb..11be17bfd8 100644 --- a/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt +++ b/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt @@ -14,7 +14,7 @@ atlas api cloudBackups deleteAllBackupSchedules Removes all cloud backup schedules for the specified cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. diff --git a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt index 29d083e8e4..0915de7a6f 100644 --- a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt @@ -14,7 +14,7 @@ atlas api cloudBackups deleteExportBucket Deletes an Export Bucket. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt index c209b88f2d..8e798ff6f4 100644 --- a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt +++ b/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt @@ -14,7 +14,7 @@ atlas api cloudBackups deleteReplicaSetBackup Removes the specified snapshot. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt index 8dc85958da..e10e7ac88c 100644 --- a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt +++ b/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt @@ -14,7 +14,7 @@ atlas api cloudBackups deleteShardedClusterBackup Removes one snapshot of one sharded cluster from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt index 7198adf20a..a38ae87390 100644 --- a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt @@ -14,7 +14,7 @@ atlas api cloudBackups disableDataProtectionSettings Disables the Backup Compliance Policy settings with the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. As a prerequisite, a support ticket needs to be file first, instructions in https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt index dccd55ea7c..1a627ef0ab 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt @@ -14,7 +14,7 @@ atlas api cloudBackups getBackupExportJob Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. diff --git a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt index 5a80391bed..f523895171 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api cloudBackups getBackupRestoreJob Returns one cloud backup restore job for one cluster from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt index 942c155820..34dc332146 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt @@ -14,7 +14,7 @@ atlas api cloudBackups getBackupSchedule Returns the cloud backup schedule for the specified cluster within the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt index d31b519529..93dd183357 100644 --- a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt @@ -14,7 +14,7 @@ atlas api cloudBackups getDataProtectionSettings Returns the Backup Compliance Policy settings with the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-getExportBucket.txt b/docs/command/atlas-api-cloudBackups-getExportBucket.txt index ab94755a8d..87aa0bf997 100644 --- a/docs/command/atlas-api-cloudBackups-getExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-getExportBucket.txt @@ -14,7 +14,7 @@ atlas api cloudBackups getExportBucket Returns one Export Bucket associated with the specified Project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt index b4ebc3a905..969d18603c 100644 --- a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt @@ -14,7 +14,7 @@ atlas api cloudBackups getReplicaSetBackup Returns one snapshot from the specified cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt index 0fa6b99538..aab8349fa9 100644 --- a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt @@ -14,7 +14,7 @@ atlas api cloudBackups getServerlessBackup Returns one snapshot of one serverless instance from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt index bf58a7f4fb..e784107b52 100644 --- a/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api cloudBackups getServerlessBackupRestoreJob Returns one restore job for one serverless instance from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt index 69414aa990..078507953d 100644 --- a/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt @@ -14,7 +14,7 @@ atlas api cloudBackups getShardedClusterBackup Returns one snapshot of one sharded cluster from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt index c2c3d2518b..85ddbf6540 100644 --- a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt @@ -14,7 +14,7 @@ atlas api cloudBackups listBackupExportJobs Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. diff --git a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt index f44fc1f293..67748dee4b 100644 --- a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt @@ -14,7 +14,7 @@ atlas api cloudBackups listBackupRestoreJobs Returns all cloud backup restore jobs for one cluster from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt index 6dc359a3d8..a31c100e5a 100644 --- a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt +++ b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt @@ -14,7 +14,7 @@ atlas api cloudBackups listExportBuckets Returns all Export Buckets associated with the specified Project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt b/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt index 2d6db0aae4..41925e8c0f 100644 --- a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt @@ -14,7 +14,7 @@ atlas api cloudBackups listReplicaSetBackups Returns all snapshots of one cluster from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt index f566bc504c..be1d43005e 100644 --- a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt @@ -14,7 +14,7 @@ atlas api cloudBackups listServerlessBackupRestoreJobs Returns all restore jobs for one serverless instance from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt index 3d1c50c656..1da6c51928 100644 --- a/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt @@ -14,7 +14,7 @@ atlas api cloudBackups listServerlessBackups Returns all snapshots of one serverless instance from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt b/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt index 75556fe853..29d5c13c6a 100644 --- a/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt @@ -14,7 +14,7 @@ atlas api cloudBackups listShardedClusterBackups Returns all snapshots of one sharded cluster from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt b/docs/command/atlas-api-cloudBackups-takeSnapshot.txt index a3c7916828..0a9559e5c8 100644 --- a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt +++ b/docs/command/atlas-api-cloudBackups-takeSnapshot.txt @@ -14,7 +14,7 @@ atlas api cloudBackups takeSnapshot Takes one on-demand snapshot for the specified cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. diff --git a/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt index 1ca3c320ea..abe39cee03 100644 --- a/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt +++ b/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt @@ -14,7 +14,7 @@ atlas api cloudBackups updateBackupSchedule Updates the cloud backup schedule for one cluster within the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt index 9cde54f9c1..6b5e7cad50 100644 --- a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt @@ -14,7 +14,7 @@ atlas api cloudBackups updateDataProtectionSettings Updates the Backup Compliance Policy settings for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt b/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt index 1854084bc7..3ceebec77d 100644 --- a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt +++ b/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt @@ -14,7 +14,7 @@ atlas api cloudBackups updateSnapshotRetention Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The requesting API Key must have the Project Backup Manager role. diff --git a/docs/command/atlas-api-cloudBackups.txt b/docs/command/atlas-api-cloudBackups.txt index 631a3ee519..a27eaa2b75 100644 --- a/docs/command/atlas-api-cloudBackups.txt +++ b/docs/command/atlas-api-cloudBackups.txt @@ -14,7 +14,7 @@ atlas api cloudBackups Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This resource applies only to clusters that use Cloud Backups. diff --git a/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt b/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt index 2f4cfbc442..3170308e82 100644 --- a/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt +++ b/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt @@ -14,7 +14,7 @@ atlas api cloudMigrationService createLinkToken Create one link-token that contains all the information required to complete the link. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. MongoDB Atlas uses the link-token for push live migrations only. Live migration (push) allows you to securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. diff --git a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt index cd780a40a4..14f134eceb 100644 --- a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt @@ -14,7 +14,7 @@ atlas api cloudMigrationService createPushMigration Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Please make sure to validate your migration before initiating it. diff --git a/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt b/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt index 7607b8cf8a..f3b15a56d2 100644 --- a/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt @@ -14,7 +14,7 @@ atlas api cloudMigrationService cutoverMigration Cut over the migrated cluster to MongoDB Atlas. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Confirm when the cut over completes. When the cut over completes, MongoDB Atlas completes the live migration process and stops synchronizing with the source cluster. Your API Key must have the Organization Owner role to successfully call this resource. diff --git a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt b/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt index 9e43c02bbf..bda9c5c3ce 100644 --- a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt +++ b/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt @@ -14,7 +14,7 @@ atlas api cloudMigrationService deleteLinkToken Remove one organization link and its associated public API key. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. diff --git a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt index baa78ac407..71f413e666 100644 --- a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt @@ -14,7 +14,7 @@ atlas api cloudMigrationService getPushMigration Return details of one cluster migration job. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Each push live migration job uses one migration host. Your API Key must have the Organization Member role to successfully call this resource. diff --git a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt b/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt index 91e39d876a..84846b38b2 100644 --- a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt +++ b/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt @@ -14,7 +14,7 @@ atlas api cloudMigrationService getValidationStatus Return the status of one migration validation job. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Your API Key must have the Organization Owner role to successfully call this resource. diff --git a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt b/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt index 982db593d5..5b76c31110 100644 --- a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt +++ b/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt @@ -14,7 +14,7 @@ atlas api cloudMigrationService listSourceProjects Return all projects that you can migrate to the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-listsourceprojects. diff --git a/docs/command/atlas-api-cloudMigrationService-validateMigration.txt b/docs/command/atlas-api-cloudMigrationService-validateMigration.txt index a77363dd29..3c7d2f533c 100644 --- a/docs/command/atlas-api-cloudMigrationService-validateMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-validateMigration.txt @@ -14,7 +14,7 @@ atlas api cloudMigrationService validateMigration Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. If the check passes, the migration can proceed. Your API Key must have the Organization Owner role to successfully call this resource. diff --git a/docs/command/atlas-api-cloudMigrationService.txt b/docs/command/atlas-api-cloudMigrationService.txt index 02c0a011c4..9a03f52869 100644 --- a/docs/command/atlas-api-cloudMigrationService.txt +++ b/docs/command/atlas-api-cloudMigrationService.txt @@ -14,7 +14,7 @@ atlas api cloudMigrationService Manages the Cloud Migration Service. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Source organizations, projects, and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations, projects, and MongoDB clusters reside on MongoDB Cloud. Source databases can't use any authentication except SCRAM-SHA. diff --git a/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt index ede25ccad0..5856906dc5 100644 --- a/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt @@ -14,7 +14,7 @@ atlas api cloudProviderAccess authorizeCloudProviderAccessRole Grants access to the specified project for the specified access role. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. This is not required for GCP service account access. diff --git a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt index 820814d4dc..1abb3f0e51 100644 --- a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt @@ -14,7 +14,7 @@ atlas api cloudProviderAccess createCloudProviderAccessRole Creates one access role for the specified cloud provider. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. 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. 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. diff --git a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt index 493c6b5f2d..c57a6eb0f0 100644 --- a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt @@ -14,7 +14,7 @@ atlas api cloudProviderAccess deauthorizeCloudProviderAccessRole Revokes access to the specified project for the specified access role. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt index c8dffe24cb..2e4aea81dd 100644 --- a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt @@ -14,7 +14,7 @@ atlas api cloudProviderAccess getCloudProviderAccessRole Returns the access role with the specified id and with access to the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt index 77767412f1..d626b2a834 100644 --- a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt +++ b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt @@ -14,7 +14,7 @@ atlas api cloudProviderAccess listCloudProviderAccessRoles Returns all cloud provider access roles with access to the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-cloudProviderAccess.txt b/docs/command/atlas-api-cloudProviderAccess.txt index 26d6a05ff3..c8088bc4fb 100644 --- a/docs/command/atlas-api-cloudProviderAccess.txt +++ b/docs/command/atlas-api-cloudProviderAccess.txt @@ -14,7 +14,7 @@ atlas api cloudProviderAccess Returns, adds, authorizes, and removes AWS IAM roles in Atlas. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt index dcfb0e701b..64834edc35 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt @@ -14,7 +14,7 @@ atlas api clusterOutageSimulation endOutageSimulation Ends a cluster outage simulation. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-endoutagesimulation. diff --git a/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt index c51d6c25cf..a218d7fcd5 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt @@ -14,7 +14,7 @@ atlas api clusterOutageSimulation getOutageSimulation Returns one outage simulation for one cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getoutagesimulation. diff --git a/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt index e19c61fc1a..5f8f61b359 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt @@ -14,7 +14,7 @@ atlas api clusterOutageSimulation startOutageSimulation Starts a cluster outage simulation. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-startoutagesimulation. diff --git a/docs/command/atlas-api-clusterOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation.txt index 5c6a5aee0e..eff6824906 100644 --- a/docs/command/atlas-api-clusterOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation.txt @@ -14,7 +14,7 @@ atlas api clusterOutageSimulation Returns, starts, or ends a cluster outage simulation. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-clusters-autoScalingConfiguration.txt b/docs/command/atlas-api-clusters-autoScalingConfiguration.txt index a3dc4f97eb..4c2035b567 100644 --- a/docs/command/atlas-api-clusters-autoScalingConfiguration.txt +++ b/docs/command/atlas-api-clusters-autoScalingConfiguration.txt @@ -14,7 +14,7 @@ atlas api clusters autoScalingConfiguration Returns the internal configuration of AutoScaling for sharded clusters. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This endpoint can be used for diagnostic purposes to ensure that sharded clusters updated from older APIs have gained support for AutoScaling each shard independently. diff --git a/docs/command/atlas-api-clusters-createCluster.txt b/docs/command/atlas-api-clusters-createCluster.txt index 3aa45b9373..27ab5876a7 100644 --- a/docs/command/atlas-api-clusters-createCluster.txt +++ b/docs/command/atlas-api-clusters-createCluster.txt @@ -14,7 +14,7 @@ atlas api clusters createCluster Creates one cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature is not available for serverless clusters. diff --git a/docs/command/atlas-api-clusters-deleteCluster.txt b/docs/command/atlas-api-clusters-deleteCluster.txt index 6598a93aa8..d1d2a2ba82 100644 --- a/docs/command/atlas-api-clusters-deleteCluster.txt +++ b/docs/command/atlas-api-clusters-deleteCluster.txt @@ -14,7 +14,7 @@ atlas api clusters deleteCluster Removes one cluster from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature is not available for serverless clusters. diff --git a/docs/command/atlas-api-clusters-getCluster.txt b/docs/command/atlas-api-clusters-getCluster.txt index 9604a8a382..a592153b08 100644 --- a/docs/command/atlas-api-clusters-getCluster.txt +++ b/docs/command/atlas-api-clusters-getCluster.txt @@ -14,7 +14,7 @@ atlas api clusters getCluster Returns the details for one cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This feature is not available for serverless clusters. diff --git a/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt index a51eac7571..29ee73a906 100644 --- a/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt +++ b/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt @@ -14,7 +14,7 @@ atlas api clusters getClusterAdvancedConfiguration Returns the advanced configuration details for one cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-clusters-getClusterStatus.txt b/docs/command/atlas-api-clusters-getClusterStatus.txt index b8269aafd7..a94da30db0 100644 --- a/docs/command/atlas-api-clusters-getClusterStatus.txt +++ b/docs/command/atlas-api-clusters-getClusterStatus.txt @@ -14,7 +14,7 @@ atlas api clusters getClusterStatus Returns the status of all changes that you made to the specified cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt b/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt index 8f58b41ff9..021b5d48aa 100644 --- a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt +++ b/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt @@ -14,7 +14,7 @@ atlas api clusters getSampleDatasetLoadStatus Checks the progress of loading the sample dataset into one cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt index 72c69ca137..7ad008f1d0 100644 --- a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt +++ b/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt @@ -14,7 +14,7 @@ atlas api clusters grantMongoDbEmployeeAccess Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-grantmongodbemployeeaccess. diff --git a/docs/command/atlas-api-clusters-listCloudProviderRegions.txt b/docs/command/atlas-api-clusters-listCloudProviderRegions.txt index 78713c68d6..97e8007829 100644 --- a/docs/command/atlas-api-clusters-listCloudProviderRegions.txt +++ b/docs/command/atlas-api-clusters-listCloudProviderRegions.txt @@ -14,7 +14,7 @@ atlas api clusters listCloudProviderRegions Returns the list of regions available for the specified cloud provider at the specified tier. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-clusters-listClusters.txt b/docs/command/atlas-api-clusters-listClusters.txt index a2b8ad4770..f36ae48865 100644 --- a/docs/command/atlas-api-clusters-listClusters.txt +++ b/docs/command/atlas-api-clusters-listClusters.txt @@ -14,7 +14,7 @@ atlas api clusters listClusters Returns the details for all clusters in the specific project to which you have access. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This feature is not available for serverless clusters. diff --git a/docs/command/atlas-api-clusters-listClustersForAllProjects.txt b/docs/command/atlas-api-clusters-listClustersForAllProjects.txt index d786c09da6..a04731e05c 100644 --- a/docs/command/atlas-api-clusters-listClustersForAllProjects.txt +++ b/docs/command/atlas-api-clusters-listClustersForAllProjects.txt @@ -14,7 +14,7 @@ atlas api clusters listClustersForAllProjects Returns the details for all clusters in all projects to which you have access. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting Service Account or API Key can have any cluster-level role. diff --git a/docs/command/atlas-api-clusters-loadSampleDataset.txt b/docs/command/atlas-api-clusters-loadSampleDataset.txt index c41cb31d66..ae7cb6c534 100644 --- a/docs/command/atlas-api-clusters-loadSampleDataset.txt +++ b/docs/command/atlas-api-clusters-loadSampleDataset.txt @@ -14,7 +14,7 @@ atlas api clusters loadSampleDataset Requests loading the MongoDB sample dataset into the specified cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt index ddcb481336..23d2c0af0c 100644 --- a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt +++ b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt @@ -14,7 +14,7 @@ atlas api clusters pinFeatureCompatibilityVersion Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. If an FCV pin already exists for the cluster, calling this method will only update the expiration date of the existing pin and will not repin the FCV. diff --git a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt index 7271eb7093..122709bbbd 100644 --- a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt +++ b/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt @@ -14,7 +14,7 @@ atlas api clusters revokeMongoDbEmployeeAccess Revokes a previously granted MongoDB employee cluster access. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-revokemongodbemployeeaccess. diff --git a/docs/command/atlas-api-clusters-testFailover.txt b/docs/command/atlas-api-clusters-testFailover.txt index 03a6941d74..52f363732a 100644 --- a/docs/command/atlas-api-clusters-testFailover.txt +++ b/docs/command/atlas-api-clusters-testFailover.txt @@ -14,7 +14,7 @@ atlas api clusters testFailover Starts a failover test for the specified cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. diff --git a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt index b0f477f791..e4190cc5c2 100644 --- a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt +++ b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt @@ -14,7 +14,7 @@ atlas api clusters unpinFeatureCompatibilityVersion Unpins the current fixed Feature Compatibility Version (FCV). -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This feature is not available for clusters on rapid release. diff --git a/docs/command/atlas-api-clusters-updateCluster.txt b/docs/command/atlas-api-clusters-updateCluster.txt index 73eadd9d80..16b2e16d0a 100644 --- a/docs/command/atlas-api-clusters-updateCluster.txt +++ b/docs/command/atlas-api-clusters-updateCluster.txt @@ -14,7 +14,7 @@ atlas api clusters updateCluster Updates the details for one cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Clusters contain a group of hosts that maintain the same data set. This resource can update clusters with asymmetrically-sized shards. To update a cluster's termination protection, the requesting Service Account or API Key must have the Project Owner role. For all other updates, the requesting Service Account or API Key must have the Project Cluster Manager role. You can't modify a paused cluster (paused : true). You must call this endpoint to set paused : false. After this endpoint responds with paused : false, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters. diff --git a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt index 999324ad2f..79e5e43daa 100644 --- a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt +++ b/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt @@ -14,7 +14,7 @@ atlas api clusters updateClusterAdvancedConfiguration Updates the advanced configuration details for one cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. diff --git a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt b/docs/command/atlas-api-clusters-upgradeSharedCluster.txt index b539a581c3..04d16109da 100644 --- a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt +++ b/docs/command/atlas-api-clusters-upgradeSharedCluster.txt @@ -14,7 +14,7 @@ atlas api clusters upgradeSharedCluster Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. Each project supports up to 25 clusters. diff --git a/docs/command/atlas-api-clusters.txt b/docs/command/atlas-api-clusters.txt index 1a1ef9cce6..3cba9bb6cd 100644 --- a/docs/command/atlas-api-clusters.txt +++ b/docs/command/atlas-api-clusters.txt @@ -14,7 +14,7 @@ atlas api clusters Returns, adds, edits, and removes database deployments. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Changes to cluster configurations can affect costs. This resource requires your Project ID. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt index a0ce6af2e1..7568a29d8f 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt @@ -14,7 +14,7 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceClusterMeasurements Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getcollstatslatencynamespaceclustermeasurements. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt index e4bda133fa..f0bbaaca49 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt @@ -14,7 +14,7 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceHostMeasurements Get a list of the Coll Stats Latency process-level measurements for the given namespace. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getcollstatslatencynamespacehostmeasurements. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt index b6376f0eae..b0fd7fcd5f 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt @@ -14,7 +14,7 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceMetrics Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getcollstatslatencynamespacemetrics. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt index 97dd6fba93..24fc6c52e7 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt @@ -14,7 +14,7 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForCluster Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getcollstatslatencynamespacesforcluster. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt index 106c8c4ed5..192629b53a 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt @@ -14,7 +14,7 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForHost Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getcollstatslatencynamespacesforhost. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt index a462d9715c..4802c98956 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt @@ -14,7 +14,7 @@ atlas api collectionLevelMetrics getPinnedNamespaces Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getpinnednamespaces. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt index 7a7e755c71..a9aaae3fba 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt @@ -14,7 +14,7 @@ atlas api collectionLevelMetrics pinNamespacesPatch Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-pinnamespacespatch. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt index 4cc7da3f9e..c48607de17 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt @@ -14,7 +14,7 @@ atlas api collectionLevelMetrics pinNamespacesPut Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This initializes a pinned namespaces list or replaces any existing pinned namespaces list for the Group and Cluster. diff --git a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt index 61ccbfd70c..2ad8558d5a 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt @@ -14,7 +14,7 @@ atlas api collectionLevelMetrics unpinNamespaces Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-unpinnamespaces. diff --git a/docs/command/atlas-api-collectionLevelMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics.txt index 372d532800..7c98c6d7ab 100644 --- a/docs/command/atlas-api-collectionLevelMetrics.txt +++ b/docs/command/atlas-api-collectionLevelMetrics.txt @@ -14,7 +14,7 @@ atlas api collectionLevelMetrics Returns, adds, and edits pinned namespaces for the specified cluster or process. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Also returns collection level latency metric data. diff --git a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt index 483eea15fd..0279d4e850 100644 --- a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt @@ -14,7 +14,7 @@ atlas api customDatabaseRoles createCustomDatabaseRole Creates one custom role in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt index ff57f0986c..5f1afb7114 100644 --- a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt @@ -14,7 +14,7 @@ atlas api customDatabaseRoles deleteCustomDatabaseRole Removes one custom role from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt index b7b8362ad3..c6fd0e79f3 100644 --- a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt @@ -14,7 +14,7 @@ atlas api customDatabaseRoles getCustomDatabaseRole Returns one custom role for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt index ec61b59614..9ceeec7037 100644 --- a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt +++ b/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt @@ -14,7 +14,7 @@ atlas api customDatabaseRoles listCustomDatabaseRoles Returns all custom roles for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt index dc1194c548..bed132dcab 100644 --- a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt @@ -14,7 +14,7 @@ atlas api customDatabaseRoles updateCustomDatabaseRole Updates one custom role in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-customDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles.txt index bde7167f56..d36989cd3e 100644 --- a/docs/command/atlas-api-customDatabaseRoles.txt +++ b/docs/command/atlas-api-customDatabaseRoles.txt @@ -14,7 +14,7 @@ atlas api customDatabaseRoles Returns, adds, edits, and removes custom database user privilege roles. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. You define custom roles at the project level, for all clusters in the project. This resource supports a subset of MongoDB privilege actions. You can create a subset of custom role actions. To create a wider list of custom role actions, use the MongoDB Cloud user interface. Custom roles must include actions that all project's clusters support, and that are compatible with each MongoDB version that your project's clusters use. For example, if your project has MongoDB 4.2 clusters, you can't create custom roles that use actions introduced in MongoDB 4.4. diff --git a/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt index bbec12e29e..3d9209b6e8 100644 --- a/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api dataFederation createDataFederationPrivateEndpoint Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. diff --git a/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt index 4ed92fc995..d87a6af047 100644 --- a/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt @@ -14,7 +14,7 @@ atlas api dataFederation createFederatedDatabase Creates one federated database instance in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. diff --git a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt b/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt index cd6d8a0f17..ea96f88187 100644 --- a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt @@ -14,7 +14,7 @@ atlas api dataFederation createOneDataFederationQueryLimit Creates or updates one query limit for one federated database instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt index d74508b962..5185b46523 100644 --- a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api dataFederation deleteDataFederationPrivateEndpoint Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt index 35bdbe08b9..c28dc14550 100644 --- a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt @@ -14,7 +14,7 @@ atlas api dataFederation deleteFederatedDatabase Removes one federated database instance from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. diff --git a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt b/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt index 24e871e232..30cbec8be6 100644 --- a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt @@ -14,7 +14,7 @@ atlas api dataFederation deleteOneDataFederationInstanceQueryLimit Deletes one query limit for one federated database instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt b/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt index 483c4d5b2c..9825793197 100644 --- a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt +++ b/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt @@ -14,7 +14,7 @@ atlas api dataFederation downloadFederatedDatabaseQueryLogs Downloads the query logs for the specified federated database instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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". diff --git a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt index 2f9e802788..a9e21bf524 100644 --- a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api dataFederation getDataFederationPrivateEndpoint Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. diff --git a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt index 975d6750c7..4657140506 100644 --- a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt @@ -14,7 +14,7 @@ atlas api dataFederation getFederatedDatabase Returns the details of one federated database instance within the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. diff --git a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt b/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt index a52b373e33..c84a895269 100644 --- a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt +++ b/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt @@ -14,7 +14,7 @@ atlas api dataFederation listDataFederationPrivateEndpoints Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. diff --git a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt b/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt index 26dde837a0..b568b10941 100644 --- a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt +++ b/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt @@ -14,7 +14,7 @@ atlas api dataFederation listFederatedDatabases Returns the details of all federated database instances in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only or higher role. diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt index 95a3e670c9..e248f1f93d 100644 --- a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt @@ -14,7 +14,7 @@ atlas api dataFederation returnFederatedDatabaseQueryLimit Returns the details of one query limit for the specified federated database instance in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt index 650350e174..d4f708f623 100644 --- a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt +++ b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt @@ -14,7 +14,7 @@ atlas api dataFederation returnFederatedDatabaseQueryLimits Returns query limits for a federated databases instance in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt index 2a52b808c6..ba2812a205 100644 --- a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt @@ -14,7 +14,7 @@ atlas api dataFederation updateFederatedDatabase Updates the details of one federated database instance in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner or higher role. diff --git a/docs/command/atlas-api-dataFederation.txt b/docs/command/atlas-api-dataFederation.txt index fb32dd60ce..e80491101f 100644 --- a/docs/command/atlas-api-dataFederation.txt +++ b/docs/command/atlas-api-dataFederation.txt @@ -14,7 +14,7 @@ atlas api dataFederation Returns, adds, edits, and removes Federated Database Instances. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This resource requires your project ID. Changes to federated database instance configurations can affect costs. diff --git a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt index 3f6983ce8b..6c86460a84 100644 --- a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt @@ -14,7 +14,7 @@ atlas api databaseUsers createDatabaseUser Creates one database user in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This MongoDB Cloud supports a maximum of 100 database users per project. If you require more than 100 database users on a project, contact Support. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt index 2d3a01065c..7f04bd8004 100644 --- a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt @@ -14,7 +14,7 @@ atlas api databaseUsers deleteDatabaseUser Removes one database user from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt index c73c8a41ae..9211e0cbde 100644 --- a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt @@ -14,7 +14,7 @@ atlas api databaseUsers getDatabaseUser Returns one database user that belong to the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt index fdaa742090..42735ce488 100644 --- a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt +++ b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt @@ -14,7 +14,7 @@ atlas api databaseUsers listDatabaseUsers Returns all database users that belong to the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt index 9849f1ed7c..e23f8bf25d 100644 --- a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt @@ -14,7 +14,7 @@ atlas api databaseUsers updateDatabaseUser Updates one database user that belongs to the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. diff --git a/docs/command/atlas-api-databaseUsers.txt b/docs/command/atlas-api-databaseUsers.txt index bb842fd0e6..c9748805ef 100644 --- a/docs/command/atlas-api-databaseUsers.txt +++ b/docs/command/atlas-api-databaseUsers.txt @@ -14,7 +14,7 @@ atlas api databaseUsers Returns, adds, edits, and removes database users. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt index 415704f94c..862f924526 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api encryptionAtRestUsingCustomerKeyManagement createEncryptionAtRestPriva Creates a private endpoint in the specified region for encryption at rest using customer key management. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-createencryptionatrestprivateendpoint. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt index 305d58ee67..2de42f11ea 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt @@ -14,7 +14,7 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRest Returns the configuration for encryption at rest using the keys you manage through your cloud provider. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting Service Account or API Key to have the Project Owner role. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt index f02000dfe0..87b4960cfe 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateE Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getencryptionatrestprivateendpoint. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt index 7bee64ffc2..0df51d9fba 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt @@ -14,7 +14,7 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateE Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getencryptionatrestprivateendpointsforcloudprovider. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt index e3a03b7310..d20e0ac36c 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt @@ -14,7 +14,7 @@ atlas api encryptionAtRestUsingCustomerKeyManagement requestEncryptionAtRestPriv Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-requestencryptionatrestprivateendpointdeletion. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt index 70a798ebd9..9361f13623 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt @@ -14,7 +14,7 @@ atlas api encryptionAtRestUsingCustomerKeyManagement updateEncryptionAtRest Updates the configuration for encryption at rest using the keys you manage through your cloud provider. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting Service Account or API Key to have the Project Owner role. This feature isn't available for M0 free clusters, M2, M5, or serverless clusters. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt index 5cd3af2acb..2f1af2128c 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt @@ -14,7 +14,7 @@ atlas api encryptionAtRestUsingCustomerKeyManagement Returns and edits the Encryption at Rest using Customer Key Management configuration. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. MongoDB Cloud encrypts all storage whether or not you use your own key management. diff --git a/docs/command/atlas-api-events-getOrganizationEvent.txt b/docs/command/atlas-api-events-getOrganizationEvent.txt index 9966649f3f..4a5bd2c918 100644 --- a/docs/command/atlas-api-events-getOrganizationEvent.txt +++ b/docs/command/atlas-api-events-getOrganizationEvent.txt @@ -14,7 +14,7 @@ atlas api events getOrganizationEvent Returns one event for the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. Use the Return Events from One Organization endpoint to retrieve all events to which the authenticated user has access. diff --git a/docs/command/atlas-api-events-getProjectEvent.txt b/docs/command/atlas-api-events-getProjectEvent.txt index e61fb6cc2c..ad82105976 100644 --- a/docs/command/atlas-api-events-getProjectEvent.txt +++ b/docs/command/atlas-api-events-getProjectEvent.txt @@ -14,7 +14,7 @@ atlas api events getProjectEvent Returns one event for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return Events from One Project endpoint to retrieve all events to which the authenticated user has access. diff --git a/docs/command/atlas-api-events-listEventTypes.txt b/docs/command/atlas-api-events-listEventTypes.txt index dd69cdbf48..8066a9d541 100644 --- a/docs/command/atlas-api-events-listEventTypes.txt +++ b/docs/command/atlas-api-events-listEventTypes.txt @@ -14,7 +14,7 @@ atlas api events listEventTypes Returns a list of all event types, along with a description and additional metadata about each event. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-listeventtypes. diff --git a/docs/command/atlas-api-events-listOrganizationEvents.txt b/docs/command/atlas-api-events-listOrganizationEvents.txt index d4f010cf4d..f8d812fd28 100644 --- a/docs/command/atlas-api-events-listOrganizationEvents.txt +++ b/docs/command/atlas-api-events-listOrganizationEvents.txt @@ -14,7 +14,7 @@ atlas api events listOrganizationEvents Returns events for the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-events-listProjectEvents.txt b/docs/command/atlas-api-events-listProjectEvents.txt index f52ab0fe30..9ce04e353a 100644 --- a/docs/command/atlas-api-events-listProjectEvents.txt +++ b/docs/command/atlas-api-events-listProjectEvents.txt @@ -14,7 +14,7 @@ atlas api events listProjectEvents Returns events for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-events.txt b/docs/command/atlas-api-events.txt index 585cbd208b..7bedd4eed2 100644 --- a/docs/command/atlas-api-events.txt +++ b/docs/command/atlas-api-events.txt @@ -14,7 +14,7 @@ atlas api events Returns events. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This collection remains under revision and may change. diff --git a/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt index 595cb1d45d..fe0e39a5a7 100644 --- a/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication createIdentityProvider Creates one identity provider within the specified federation. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt index 266226208d..f34a53a6b2 100644 --- a/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication createRoleMapping Adds one role mapping to the specified organization in the specified federation. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt b/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt index 8a17a7eb8f..859a9e2283 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication deleteFederationApp Deletes the federation settings instance and all associated data, including identity providers and domains. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the last remaining connected organization. Note: requests to this resource will fail if there is more than one connected organization in the federation. diff --git a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt index fe5b8bed38..ae52b2678a 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication deleteIdentityProvider Deletes one identity provider in the specified federation. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt index 17e3e4e2e6..a4f54408f6 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication deleteRoleMapping Removes one role mapping in the specified organization from the specified federation. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt index 19af52891a..75e3c3b887 100644 --- a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication getConnectedOrgConfig Returns the specified connected org config from the specified federation. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. diff --git a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt index 561d0d40e3..c66e751735 100644 --- a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt +++ b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication getFederationSettings Returns information about the federation settings for the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt index 33f2d44ecb..bef7adb763 100644 --- a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication getIdentityProvider Returns one identity provider in the specified federation by the identity provider's id. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt index af0bb6473b..c65a84ea21 100644 --- a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt +++ b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication getIdentityProviderMetadata Returns the metadata of one identity provider in the specified federation. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt index 50e6c13e29..a5521eeb2a 100644 --- a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication getRoleMapping Returns one role mapping from the specified organization in the specified federation. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt index bf8f8c4e64..e957ecdb53 100644 --- a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt +++ b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication listConnectedOrgConfigs Returns all connected org configs in the specified federation. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected orgs. diff --git a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt index d2f7a79f69..23b4a7d303 100644 --- a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt +++ b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication listIdentityProviders Returns all identity providers with the provided protocol and type in the specified federation. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt index 5eabe9cb59..e8d244a16d 100644 --- a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt +++ b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication listRoleMappings Returns all role mappings from the specified organization in the specified federation. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt index 4548d02fe2..5949703771 100644 --- a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication removeConnectedOrgConfig Removes one connected organization configuration from the specified federation. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation. diff --git a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt index e43d0f9944..4d3a90815b 100644 --- a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication revokeJwksFromIdentityProvider Revokes the JWKS tokens from the requested OIDC identity provider. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt index d1646aa411..7fc8250e0f 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication updateConnectedOrgConfig Updates one connected organization configuration from the specified federation. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt index a32858f2b8..30c0998433 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication updateIdentityProvider Updates one identity provider in the specified federation. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. diff --git a/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt index dc05c7020d..1912387ea3 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication updateRoleMapping Updates one role mapping in the specified organization in the specified federation. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-federatedAuthentication.txt b/docs/command/atlas-api-federatedAuthentication.txt index 746fc536eb..f2addd0a39 100644 --- a/docs/command/atlas-api-federatedAuthentication.txt +++ b/docs/command/atlas-api-federatedAuthentication.txt @@ -14,7 +14,7 @@ atlas api federatedAuthentication Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-flexClusters-createFlexCluster.txt b/docs/command/atlas-api-flexClusters-createFlexCluster.txt index 0e9d1655ac..0f93a76df0 100644 --- a/docs/command/atlas-api-flexClusters-createFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-createFlexCluster.txt @@ -14,7 +14,7 @@ atlas api flexClusters createFlexCluster Creates one flex cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt index 40c4735cce..2fd95d5a93 100644 --- a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt @@ -14,7 +14,7 @@ atlas api flexClusters deleteFlexCluster Removes one flex cluster from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The flex cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-flexClusters-getFlexCluster.txt b/docs/command/atlas-api-flexClusters-getFlexCluster.txt index f0af69991a..2e16283e28 100644 --- a/docs/command/atlas-api-flexClusters-getFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-getFlexCluster.txt @@ -14,7 +14,7 @@ atlas api flexClusters getFlexCluster Returns details for one flex cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-flexClusters-listFlexClusters.txt b/docs/command/atlas-api-flexClusters-listFlexClusters.txt index b58ceba0fc..f145910132 100644 --- a/docs/command/atlas-api-flexClusters-listFlexClusters.txt +++ b/docs/command/atlas-api-flexClusters-listFlexClusters.txt @@ -14,7 +14,7 @@ atlas api flexClusters listFlexClusters Returns details for all flex clusters in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt index a0041fe330..51d04e404c 100644 --- a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt @@ -14,7 +14,7 @@ atlas api flexClusters updateFlexCluster Updates one flex cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt b/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt index 3af944c292..99bbfbf3f3 100644 --- a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt @@ -14,7 +14,7 @@ atlas api flexClusters upgradeFlexCluster Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. diff --git a/docs/command/atlas-api-flexClusters.txt b/docs/command/atlas-api-flexClusters.txt index 3c6accbf51..2f757808ee 100644 --- a/docs/command/atlas-api-flexClusters.txt +++ b/docs/command/atlas-api-flexClusters.txt @@ -14,7 +14,7 @@ atlas api flexClusters Returns, adds, edits, and removes flex clusters. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt index 7d09b7b9a2..bc2c6d7255 100644 --- a/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt +++ b/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api flexRestoreJobs createFlexBackupRestoreJob Restores one snapshot of one flex cluster from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt index 3e181d8edf..6921f0a318 100644 --- a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt +++ b/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api flexRestoreJobs getFlexBackupRestoreJob Returns one restore job for one flex cluster from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt index 7310c358cf..565c9c507d 100644 --- a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt +++ b/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt @@ -14,7 +14,7 @@ atlas api flexRestoreJobs listFlexBackupRestoreJobs Returns all restore jobs for one flex cluster from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-flexRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs.txt index 54ed0f2b00..6875fe52d2 100644 --- a/docs/command/atlas-api-flexRestoreJobs.txt +++ b/docs/command/atlas-api-flexRestoreJobs.txt @@ -14,7 +14,7 @@ atlas api flexRestoreJobs Returns and adds restore jobs for flex database deployments. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt b/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt index 799d8fac9e..b6ead9f0cb 100644 --- a/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt +++ b/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt @@ -14,7 +14,7 @@ atlas api flexSnapshots downloadFlexBackup Requests one snapshot for the specified flex cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt b/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt index db0de9901c..e967c19453 100644 --- a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt +++ b/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt @@ -14,7 +14,7 @@ atlas api flexSnapshots getFlexBackup Returns one snapshot of one flex cluster from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt b/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt index 476209ca12..5e69889fda 100644 --- a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt +++ b/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt @@ -14,7 +14,7 @@ atlas api flexSnapshots listFlexBackups Returns all snapshots of one flex cluster from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-flexSnapshots.txt b/docs/command/atlas-api-flexSnapshots.txt index 1044e7d0af..0fe0bda4d7 100644 --- a/docs/command/atlas-api-flexSnapshots.txt +++ b/docs/command/atlas-api-flexSnapshots.txt @@ -14,7 +14,7 @@ atlas api flexSnapshots Returns and requests to download flex database deployment snapshots. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt b/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt index 560e2106c8..49a0f3ef66 100644 --- a/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt +++ b/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt @@ -14,7 +14,7 @@ atlas api globalClusters createCustomZoneMapping Creates one custom zone mapping for the specified global cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt index c686f3d6a6..2a09c7111d 100644 --- a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt @@ -14,7 +14,7 @@ atlas api globalClusters createManagedNamespace Creates one managed namespace within the specified global cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt b/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt index e78801e5e2..206c17bb3c 100644 --- a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt +++ b/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt @@ -14,7 +14,7 @@ atlas api globalClusters deleteAllCustomZoneMappings Removes all custom zone mappings for the specified global cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt b/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt index 193fb71d55..dcd4a92f55 100644 --- a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt @@ -14,7 +14,7 @@ atlas api globalClusters deleteManagedNamespace Removes one managed namespace within the specified global cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt b/docs/command/atlas-api-globalClusters-getManagedNamespace.txt index 48afcf3bc4..57fcb50eca 100644 --- a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-getManagedNamespace.txt @@ -14,7 +14,7 @@ atlas api globalClusters getManagedNamespace Returns one managed namespace within the specified global cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-globalClusters.txt b/docs/command/atlas-api-globalClusters.txt index 7497563288..950f60d268 100644 --- a/docs/command/atlas-api-globalClusters.txt +++ b/docs/command/atlas-api-globalClusters.txt @@ -14,7 +14,7 @@ atlas api globalClusters Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Each collection in a Global Cluster is associated with a managed namespace. When you create a managed namespace for a Global Cluster, MongoDB Cloud creates an empty collection for that namespace. Creating a managed namespace doesn't populate a collection with data. Similarly, deleting a managed namespace doesn't delete the associated collection. diff --git a/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt b/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt index 1fa44e7a9d..eb64947cd1 100644 --- a/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt +++ b/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt @@ -14,7 +14,7 @@ atlas api invoices createCostExplorerQueryProcess Creates a query process within the Cost Explorer for the given parameters. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. A token is returned that can be used to poll the status of the query and eventually retrieve the results. diff --git a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt b/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt index 656b16a899..722aa85d85 100644 --- a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt +++ b/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt @@ -14,7 +14,7 @@ atlas api invoices downloadInvoiceCsv Returns one invoice that MongoDB issued to the specified organization in CSV format. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting Service Account or API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role. diff --git a/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt b/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt index d3e72c9634..cb311b93bd 100644 --- a/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt +++ b/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt @@ -14,7 +14,7 @@ atlas api invoices getCostExplorerQueryProcess Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data. diff --git a/docs/command/atlas-api-invoices-getInvoice.txt b/docs/command/atlas-api-invoices-getInvoice.txt index 5808c3bf53..4ac8c67920 100644 --- a/docs/command/atlas-api-invoices-getInvoice.txt +++ b/docs/command/atlas-api-invoices-getInvoice.txt @@ -14,7 +14,7 @@ atlas api invoices getInvoice Returns one invoice that MongoDB issued to the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner role. diff --git a/docs/command/atlas-api-invoices-listInvoices.txt b/docs/command/atlas-api-invoices-listInvoices.txt index 1292a08c89..5d38f9506a 100644 --- a/docs/command/atlas-api-invoices-listInvoices.txt +++ b/docs/command/atlas-api-invoices-listInvoices.txt @@ -14,7 +14,7 @@ atlas api invoices listInvoices Returns all invoices that MongoDB issued to the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This list includes all invoices regardless of invoice status. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner role. diff --git a/docs/command/atlas-api-invoices-listPendingInvoices.txt b/docs/command/atlas-api-invoices-listPendingInvoices.txt index e18c5b6357..491e7e5ce2 100644 --- a/docs/command/atlas-api-invoices-listPendingInvoices.txt +++ b/docs/command/atlas-api-invoices-listPendingInvoices.txt @@ -14,7 +14,7 @@ atlas api invoices listPendingInvoices Returns all invoices accruing charges for the current billing cycle for the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. diff --git a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt b/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt index 9ca4062ea3..72d042dce2 100644 --- a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt +++ b/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt @@ -14,7 +14,7 @@ atlas api invoices queryLineItemsFromSingleInvoice Query the lineItems of the specified invoice and return the result JSON. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. A unique 24-hexadecimal digit string identifies the invoice. diff --git a/docs/command/atlas-api-invoices.txt b/docs/command/atlas-api-invoices.txt index 7adbf9fb33..a94bd24b46 100644 --- a/docs/command/atlas-api-invoices.txt +++ b/docs/command/atlas-api-invoices.txt @@ -14,7 +14,7 @@ atlas api invoices Returns invoices. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt index 4260d96bce..f5f0c82776 100644 --- a/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt @@ -14,7 +14,7 @@ atlas api ldapConfiguration deleteLdapConfiguration Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt index 7792f6e1bf..3eb6c9eb77 100644 --- a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt @@ -14,7 +14,7 @@ atlas api ldapConfiguration getLdapConfiguration Returns the current LDAP configuration for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt index 70ac260409..9ec9b2a8c4 100644 --- a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt +++ b/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt @@ -14,7 +14,7 @@ atlas api ldapConfiguration getLdapConfigurationStatus Returns the status of one request to verify one LDAP configuration for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt index 304f8a35e5..75994909af 100644 --- a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt @@ -14,7 +14,7 @@ atlas api ldapConfiguration saveLdapConfiguration Edits the LDAP configuration for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt index f203fc68f3..330461638f 100644 --- a/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt @@ -14,7 +14,7 @@ atlas api ldapConfiguration verifyLdapConfiguration Verifies the LDAP configuration for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-ldapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration.txt index 28d59f6727..6192d18453 100644 --- a/docs/command/atlas-api-ldapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration.txt @@ -14,7 +14,7 @@ atlas api ldapConfiguration Returns, edits, verifies, and removes LDAP configurations. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. An LDAP configuration defines settings for MongoDB Cloud to connect to your LDAP server over TLS for user authentication and authorization. Your LDAP server must be visible to the internet or connected to your MongoDB Cloud cluster with VPC Peering. Also, your LDAP server must use TLS. You must have the MongoDB Cloud admin user privilege to use these endpoints. Also, to configure user authentication and authorization with LDAPS, your cluster must run MongoDB 3.6 or higher. Groups for which you have configured LDAPS can't create a cluster using a version of MongoDB 3.6 or lower. diff --git a/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt b/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt index b765e9cb84..487c29cdab 100644 --- a/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt +++ b/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api legacyBackup createLegacyBackupRestoreJob Restores one legacy backup for one cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying delivery.methodName of AUTOMATED_RESTORE in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. diff --git a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt index 71e24a0138..db91b9dbc3 100644 --- a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt +++ b/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt @@ -14,7 +14,7 @@ atlas api legacyBackup deleteLegacySnapshot Removes one legacy backup snapshot for one cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt index 14b6a04cd8..cabc653943 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt @@ -14,7 +14,7 @@ atlas api legacyBackup getLegacyBackupCheckpoint Returns one legacy backup checkpoint for one cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt index 9c73a82f07..8b70b75aab 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api legacyBackup getLegacyBackupRestoreJob Returns one legacy backup restore job for one cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt index f2e456cc63..151b2aa6b7 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt @@ -14,7 +14,7 @@ atlas api legacyBackup getLegacySnapshot Returns one legacy backup snapshot for one cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt index 1d15534ea1..29ae291bda 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt @@ -14,7 +14,7 @@ atlas api legacyBackup getLegacySnapshotSchedule Returns the snapshot schedule for one cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt index 26caa02328..a4b2305837 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt @@ -14,7 +14,7 @@ atlas api legacyBackup listLegacyBackupCheckpoints Returns all legacy backup checkpoints for one cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt index c545d4f270..f501fa13eb 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt @@ -14,7 +14,7 @@ atlas api legacyBackup listLegacyBackupRestoreJobs Returns all legacy backup restore jobs for one cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt b/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt index d268c6fcf7..2a0611c74e 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt @@ -14,7 +14,7 @@ atlas api legacyBackup listLegacySnapshots Returns all legacy backup snapshots for one cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt index 14da7bb1bf..f2ed39a4e2 100644 --- a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt +++ b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt @@ -14,7 +14,7 @@ atlas api legacyBackup updateLegacySnapshotRetention Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt index 7090781ada..736e88d474 100644 --- a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt +++ b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt @@ -14,7 +14,7 @@ atlas api legacyBackup updateLegacySnapshotSchedule Updates the snapshot schedule for one cluster in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-legacyBackup.txt b/docs/command/atlas-api-legacyBackup.txt index bea5da224f..46d25f2bc0 100644 --- a/docs/command/atlas-api-legacyBackup.txt +++ b/docs/command/atlas-api-legacyBackup.txt @@ -14,7 +14,7 @@ atlas api legacyBackup Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt index ede4623302..a12219c0d9 100644 --- a/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt @@ -14,7 +14,7 @@ atlas api maintenanceWindows deferMaintenanceWindow Defers the maintenance window for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt index 309cb1c4ad..f3564540d6 100644 --- a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt @@ -14,7 +14,7 @@ atlas api maintenanceWindows getMaintenanceWindow Returns the maintenance window for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt index a155c19bf0..02ac37005d 100644 --- a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt @@ -14,7 +14,7 @@ atlas api maintenanceWindows resetMaintenanceWindow Resets the maintenance window for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt index 3193dae66c..6d6a1ac072 100644 --- a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt +++ b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt @@ -14,7 +14,7 @@ atlas api maintenanceWindows toggleMaintenanceAutoDefer Toggles automatic deferral of the maintenance window for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt index b96356c534..ea6a5a3421 100644 --- a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt @@ -14,7 +14,7 @@ atlas api maintenanceWindows updateMaintenanceWindow Updates the maintenance window for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. Updating the maintenance window will reset any maintenance deferrals for this project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-maintenanceWindows.txt b/docs/command/atlas-api-maintenanceWindows.txt index 2ab28d4117..2a4ec77c05 100644 --- a/docs/command/atlas-api-maintenanceWindows.txt +++ b/docs/command/atlas-api-maintenanceWindows.txt @@ -14,7 +14,7 @@ atlas api maintenanceWindows Returns, edits, and removes maintenance windows. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. You can defer a scheduled maintenance event for a project up to two times. Deferred maintenance events occur during your preferred maintenance window exactly one week after the previously scheduled date and time. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt index a2302c8e64..84b11b0572 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers addOrganizationRole Adds one organization-level role to the MongoDB Cloud user. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt index 1c132c4d41..4f1951c984 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers addProjectRole Adds one project-level role to the MongoDB Cloud user. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can add a role to an active user or a user that has been invited to join the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt index 8e2f94749e..15186f9a34 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers addProjectUser Adds one MongoDB Cloud user to one project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt b/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt index 3bd20d72a4..a868ab6971 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers addUserToTeam Adds one MongoDB Cloud user to one team. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can add an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt index 782d21b609..1fdf11f486 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers createOrganizationUser Invites one new or existing MongoDB Cloud user to join the organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt index 5d44429c99..4a79adc21f 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers createUser Creates one MongoDB Cloud user account. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt index dd7f9897bd..54af116288 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers getOrganizationUser Returns information about the specified MongoDB Cloud user within the context of the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt index 50573682de..8111663b2c 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers getProjectUser Returns information about the specified MongoDB Cloud user within the context of the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt index d25647ec2c..b14c1ce8c3 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers getUser Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can't use this endpoint to return information on an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. You can always retrieve your own user account. If you are the owner of a MongoDB Cloud organization or project, you can also retrieve the user profile for any user with membership in that organization or project. To use this resource, the requesting Service Account or API Key can have any role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt index a9534a84a0..a6891af2c7 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers getUserByUsername Returns the details for one MongoDB Cloud user account with the specified username. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can't use this endpoint to return information about an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. To use this resource, the requesting Service Account or API Key can have any role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt index 767837e9b3..c33380542f 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers listOrganizationUsers Returns details about the pending and active MongoDB Cloud users associated with the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt index 0f09791a7c..26509a596b 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers listProjectUsers Returns details about the pending and active MongoDB Cloud users associated with the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt index 1346f92e95..a1c0dbb9c0 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers listTeamUsers Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt index 96ae2c4cf4..a61b8ce361 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers removeOrganizationRole Removes one organization-level role from the MongoDB Cloud user. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt index 147edd4bdd..468d21a85f 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers removeOrganizationUser Removes one MongoDB Cloud user in the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt index 829638530f..c194e1a250 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers removeProjectRole Removes one project-level role from the MongoDB Cloud user. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can remove a role from an active user or a user that has been invited to join the project. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt index 17d78cb0fc..85fd5e7e57 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers removeProjectUser Removes one MongoDB Cloud user from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt index f484f50ec3..f02e8c486f 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers removeUserFromTeam Removes one MongoDB Cloud user from one team. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can remove an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt index 09f583116b..4912e0abee 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers updateOrganizationUser Updates one MongoDB Cloud user in the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-mongoDbCloudUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers.txt index 3e731b7a0c..6c12153279 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers.txt @@ -14,7 +14,7 @@ atlas api mongoDbCloudUsers Returns, adds, and edits MongoDB Cloud users. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt b/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt index ea6ea8aefe..b4e9e55473 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs getAtlasProcess Returns the processes for the specified host for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt index ce79935833..0d66472be0 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs getDatabase Returns one database running on the specified host for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt index 1bc1ec14d1..58bfea356c 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs getDatabaseMeasurements Returns the measurements of one database for the specified host for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Returns the database's on-disk storage space based on the MongoDB dbStats command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt index 08378b57fd..650d607973 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs getDiskMeasurements Returns the measurements of one disk or partition for the specified host for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Returned value can be one of the following: diff --git a/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt b/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt index dd34f37e26..d22585853a 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs getHostLogs Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes. Logs are stored in chunks approximately five minutes in length, but this duration may vary. If you poll the API for log files, we recommend polling every five minutes even though consecutive polls could contain some overlapping logs. This feature isn't available for M0 free clusters, M2, M5, flex, or serverless clusters. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". diff --git a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt index 4106f42a7a..b933b77a91 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs getHostMeasurements Returns disk, partition, or host measurements per process for the specified host for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Returned value can be one of the following: diff --git a/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt b/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt index d15958b30f..74ab6265b8 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs getIndexMetrics Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You must have the Project Read Only or higher role to view the Atlas Search metric types. diff --git a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt index 94dda4970d..a4235ea3fc 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs getMeasurements Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You must have the Project Read Only or higher role to view the Atlas Search metric types. diff --git a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt b/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt index c7a275e69d..4ec55fa530 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs listAtlasProcesses Returns details of all processes for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. A MongoDB process can be either a mongod or mongos. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt index e214ba60eb..e204d315bd 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs listDatabases Returns the list of databases running on the specified host for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt index 9acd28eda3..735e296e46 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs listDiskMeasurements Returns measurement details for one disk or partition for the specified host for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt index fc46f9b956..0b1024627a 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs listDiskPartitions Returns the list of disks or partitions for the specified host for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt b/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt index 67b592ec2e..158b2a66cc 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs listIndexMetrics Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-listindexmetrics. diff --git a/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt b/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt index 980662747c..03e0c837dc 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs listMetricTypes Returns all Atlas Search metric types available for one process in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You must have the Project Read Only or higher role to view the Atlas Search metric types. diff --git a/docs/command/atlas-api-monitoringAndLogs.txt b/docs/command/atlas-api-monitoringAndLogs.txt index 96a7dd5613..5201c2aed6 100644 --- a/docs/command/atlas-api-monitoringAndLogs.txt +++ b/docs/command/atlas-api-monitoringAndLogs.txt @@ -14,7 +14,7 @@ atlas api monitoringAndLogs Returns database deployment monitoring and logging data. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-networkPeering-createPeeringConnection.txt b/docs/command/atlas-api-networkPeering-createPeeringConnection.txt index 789005917d..5cac0abd18 100644 --- a/docs/command/atlas-api-networkPeering-createPeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-createPeeringConnection.txt @@ -14,7 +14,7 @@ atlas api networkPeering createPeeringConnection Creates one new network peering connection in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. diff --git a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt b/docs/command/atlas-api-networkPeering-createPeeringContainer.txt index 04923795c3..d2d57d7c03 100644 --- a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-createPeeringContainer.txt @@ -14,7 +14,7 @@ atlas api networkPeering createPeeringContainer Creates one new network peering container in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt b/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt index 9ba68e6fba..4f6d03660d 100644 --- a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt @@ -14,7 +14,7 @@ atlas api networkPeering deletePeeringConnection Removes one network peering connection in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt b/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt index a2e43fe7dd..87c756da24 100644 --- a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt @@ -14,7 +14,7 @@ atlas api networkPeering deletePeeringContainer Removes one network peering container in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-networkPeering-disablePeering.txt b/docs/command/atlas-api-networkPeering-disablePeering.txt index 61f79df2ca..f66f6e977f 100644 --- a/docs/command/atlas-api-networkPeering-disablePeering.txt +++ b/docs/command/atlas-api-networkPeering-disablePeering.txt @@ -14,7 +14,7 @@ atlas api networkPeering disablePeering Disables Connect via Peering Only mode for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt b/docs/command/atlas-api-networkPeering-getPeeringConnection.txt index 638d71c608..b6ccca58bb 100644 --- a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-getPeeringConnection.txt @@ -14,7 +14,7 @@ atlas api networkPeering getPeeringConnection Returns details about one specified network peering connection in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt b/docs/command/atlas-api-networkPeering-getPeeringContainer.txt index df88ccb1a7..34917e8ec0 100644 --- a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-getPeeringContainer.txt @@ -14,7 +14,7 @@ atlas api networkPeering getPeeringContainer Returns details about one network peering container in one specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt b/docs/command/atlas-api-networkPeering-listPeeringConnections.txt index c414b0ca0d..78a84abdd4 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringConnections.txt @@ -14,7 +14,7 @@ atlas api networkPeering listPeeringConnections Returns details about all network peering connections in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt b/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt index 748dc70674..ac92413e11 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt @@ -14,7 +14,7 @@ atlas api networkPeering listPeeringContainerByCloudProvider Returns details about all network peering containers in the specified project for the specified cloud provider. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt b/docs/command/atlas-api-networkPeering-listPeeringContainers.txt index 7abddb70ae..45af75c9cf 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringContainers.txt @@ -14,7 +14,7 @@ atlas api networkPeering listPeeringContainers Returns details about all network peering containers in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt b/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt index 3329de3d04..5a92893648 100644 --- a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt @@ -14,7 +14,7 @@ atlas api networkPeering updatePeeringConnection Updates one specified network peering connection in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt b/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt index bc13806cdc..950ea9c8da 100644 --- a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt @@ -14,7 +14,7 @@ atlas api networkPeering updatePeeringContainer Updates the network details and labels of one specified network peering container in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt b/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt index 42da353132..176edc1361 100644 --- a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt +++ b/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt @@ -14,7 +14,7 @@ atlas api networkPeering verifyConnectViaPeeringOnlyModeForOneProject Verifies if someone set the specified project to Connect via Peering Only mode. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-networkPeering.txt b/docs/command/atlas-api-networkPeering.txt index 14cd13f8a7..dc2b326588 100644 --- a/docs/command/atlas-api-networkPeering.txt +++ b/docs/command/atlas-api-networkPeering.txt @@ -14,7 +14,7 @@ atlas api networkPeering Returns, adds, edits, and removes network peering containers and peering connections. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. When you deploy an M10+ dedicated cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block. diff --git a/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt index 788f22f19c..3a640d5003 100644 --- a/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt @@ -14,7 +14,7 @@ atlas api onlineArchive createOnlineArchive Creates one online archive. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt index d13c362323..2b5c9e9817 100644 --- a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt @@ -14,7 +14,7 @@ atlas api onlineArchive deleteOnlineArchive Removes one online archive. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt b/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt index d5ee67c10a..7405f7e0d6 100644 --- a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt +++ b/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt @@ -14,7 +14,7 @@ atlas api onlineArchive downloadOnlineArchiveQueryLogs Downloads query logs for the specified online archive. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". diff --git a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt index 2fcdba9a55..3e80241006 100644 --- a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt @@ -14,7 +14,7 @@ atlas api onlineArchive getOnlineArchive Returns one online archive for one cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt index dd2054b5cc..4404520af5 100644 --- a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt +++ b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt @@ -14,7 +14,7 @@ atlas api onlineArchive listOnlineArchives Returns details of all online archives. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt index 575c07d8d9..18d6eebccd 100644 --- a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt @@ -14,7 +14,7 @@ atlas api onlineArchive updateOnlineArchive Updates, pauses, or resumes one online archive. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-onlineArchive.txt b/docs/command/atlas-api-onlineArchive.txt index 6c482167de..ea95db3e4e 100644 --- a/docs/command/atlas-api-onlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive.txt @@ -14,7 +14,7 @@ atlas api onlineArchive Returns, adds, edits, or removes an online archive. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-organizations-createOrganization.txt b/docs/command/atlas-api-organizations-createOrganization.txt index 87127c5ba7..06bd3e8da9 100644 --- a/docs/command/atlas-api-organizations-createOrganization.txt +++ b/docs/command/atlas-api-organizations-createOrganization.txt @@ -14,7 +14,7 @@ atlas api organizations createOrganization Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. The requesting Service Account's or API Key's organization must be a paying organization. To learn more, see Configure a Paying Organization in the MongoDB Atlas documentation. diff --git a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt b/docs/command/atlas-api-organizations-createOrganizationInvitation.txt index 7f27f767e3..3b35905b67 100644 --- a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-createOrganizationInvitation.txt @@ -14,7 +14,7 @@ atlas api organizations createOrganizationInvitation Invites one MongoDB Cloud user to join the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The user must accept the invitation to access information within the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-deleteOrganization.txt b/docs/command/atlas-api-organizations-deleteOrganization.txt index 2843acbfb6..07c83978e9 100644 --- a/docs/command/atlas-api-organizations-deleteOrganization.txt +++ b/docs/command/atlas-api-organizations-deleteOrganization.txt @@ -14,7 +14,7 @@ atlas api organizations deleteOrganization Removes one specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. MongoDB Cloud imposes the following limits on this resource: diff --git a/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt b/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt index 7af3b8c337..b9d46c3e5a 100644 --- a/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt @@ -14,7 +14,7 @@ atlas api organizations deleteOrganizationInvitation Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can't cancel an invitation that the user accepted. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-getOrganization.txt b/docs/command/atlas-api-organizations-getOrganization.txt index 4c66edce1b..0adf0ab304 100644 --- a/docs/command/atlas-api-organizations-getOrganization.txt +++ b/docs/command/atlas-api-organizations-getOrganization.txt @@ -14,7 +14,7 @@ atlas api organizations getOrganization Returns one organization to which the requesting Service Account or API Key has access. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt b/docs/command/atlas-api-organizations-getOrganizationInvitation.txt index 0598b5df2b..65f773758c 100644 --- a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-getOrganizationInvitation.txt @@ -14,7 +14,7 @@ atlas api organizations getOrganizationInvitation Returns the details of one pending invitation to the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-getOrganizationSettings.txt b/docs/command/atlas-api-organizations-getOrganizationSettings.txt index e282c80214..6330c6cdaa 100644 --- a/docs/command/atlas-api-organizations-getOrganizationSettings.txt +++ b/docs/command/atlas-api-organizations-getOrganizationSettings.txt @@ -14,7 +14,7 @@ atlas api organizations getOrganizationSettings Returns details about the specified organization's settings. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt index 6cc3db893b..019e106ca9 100644 --- a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt +++ b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt @@ -14,7 +14,7 @@ atlas api organizations listOrganizationInvitations Returns all pending invitations to the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-listOrganizationProjects.txt b/docs/command/atlas-api-organizations-listOrganizationProjects.txt index 5bd1550f03..c1fa9cf9f8 100644 --- a/docs/command/atlas-api-organizations-listOrganizationProjects.txt +++ b/docs/command/atlas-api-organizations-listOrganizationProjects.txt @@ -14,7 +14,7 @@ atlas api organizations listOrganizationProjects Returns multiple projects in the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Each organization can have multiple projects. Use projects to: diff --git a/docs/command/atlas-api-organizations-listOrganizations.txt b/docs/command/atlas-api-organizations-listOrganizations.txt index 7475d492c0..d602c2c565 100644 --- a/docs/command/atlas-api-organizations-listOrganizations.txt +++ b/docs/command/atlas-api-organizations-listOrganizations.txt @@ -14,7 +14,7 @@ atlas api organizations listOrganizations Returns all organizations to which the requesting Service Account or API Key has access. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-organizations-updateOrganization.txt b/docs/command/atlas-api-organizations-updateOrganization.txt index 9d2f6a97a3..9c78322dee 100644 --- a/docs/command/atlas-api-organizations-updateOrganization.txt +++ b/docs/command/atlas-api-organizations-updateOrganization.txt @@ -14,7 +14,7 @@ atlas api organizations updateOrganization Updates one organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt index 89d5876a04..042e859321 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt @@ -14,7 +14,7 @@ atlas api organizations updateOrganizationInvitation Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt index 2858acdee9..e33350b548 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt @@ -14,7 +14,7 @@ atlas api organizations updateOrganizationInvitationById Updates the details of one pending invitation, identified by its unique ID, to the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Use the Return All Organization Invitations endpoint to retrieve IDs for all pending organization invitations. To use this resource, the requesting API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt b/docs/command/atlas-api-organizations-updateOrganizationRoles.txt index 320dce69cf..dbe7f74374 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationRoles.txt @@ -14,7 +14,7 @@ atlas api organizations updateOrganizationRoles Updates the roles of the specified user in the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization User Admin role. diff --git a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt b/docs/command/atlas-api-organizations-updateOrganizationSettings.txt index 68427ccb6c..3eed6e3c7b 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationSettings.txt @@ -14,7 +14,7 @@ atlas api organizations updateOrganizationSettings Updates the organization's settings. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-organizations.txt b/docs/command/atlas-api-organizations.txt index 99b9d77eba..b87afb10d9 100644 --- a/docs/command/atlas-api-organizations.txt +++ b/docs/command/atlas-api-organizations.txt @@ -14,7 +14,7 @@ atlas api organizations Returns, adds, and edits organizational units in MongoDB Cloud. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt b/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt index b8efb335d3..6f03a1de12 100644 --- a/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt +++ b/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor disableSlowOperationThresholding Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt b/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt index 1da5c3db53..7fd3cc2f70 100644 --- a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt +++ b/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor enableSlowOperationThresholding Enables MongoDB Cloud to use its slow operation threshold for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt index 9b31eeebf0..bfc7f73294 100644 --- a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt +++ b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor getManagedSlowMs Get whether the Managed Slow MS feature is enabled. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getmanagedslowms. diff --git a/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt index 1c82f2ae06..45b231f46a 100644 --- a/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt +++ b/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor getServerlessAutoIndexing Get whether the Serverless Auto Indexing feature is enabled. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This endpoint returns 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. diff --git a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt index df545afdc1..10c02a0e12 100644 --- a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor listClusterSuggestedIndexes Returns the indexes that the Performance Advisor suggests. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt index d513179fe4..db1889b183 100644 --- a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor listDropIndexes Returns the indexes that the Performance Advisor suggests to drop. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt index f0eb00db8c..093b4d007d 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor listSchemaAdvice Returns the schema suggestions that the Performance Advisor detects. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The Performance Advisor provides holistic schema recommendations for your cluster by sampling documents in your most active collections and collections with slow-running queries. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt index 5e1b36bfb2..605b73a2be 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor listSlowQueries Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting Service Account or API Key must have any Project Data Access role or the Project Observability Viewer role. diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt index a2974f7a63..1aee593136 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor listSlowQueryNamespaces Returns up to 20 namespaces for collections experiencing slow queries on the specified host. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt index 62422cd6b9..10ee71066f 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor listSuggestedIndexes Returns the indexes that the Performance Advisor suggests. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt index 5b604f9089..ea5d341e6a 100644 --- a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt +++ b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor setServerlessAutoIndexing Set whether the Serverless Auto Indexing feature is enabled. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-performanceAdvisor.txt b/docs/command/atlas-api-performanceAdvisor.txt index 15925ee0ab..ac792e2593 100644 --- a/docs/command/atlas-api-performanceAdvisor.txt +++ b/docs/command/atlas-api-performanceAdvisor.txt @@ -14,7 +14,7 @@ atlas api performanceAdvisor Returns suggested indexes and slow query data for a database deployment. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a sample query, you must have the Project Data Access Read Only role or higher. Otherwise, MongoDB Cloud returns redacted data rather than the field values. diff --git a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt index 79ff6abc17..f4f3cf17a0 100644 --- a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices createPrivateEndpoint Creates one private endpoint for the specified cloud service provider. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. diff --git a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt index db63746c73..81d2748b19 100644 --- a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices createPrivateEndpointService Creates one private endpoint service for the specified cloud service provider. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt index d188c58495..2ac9f1bfce 100644 --- a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices deletePrivateEndpoint Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt index 0b6e551ffc..15552b40eb 100644 --- a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices deletePrivateEndpointService Removes one private endpoint service from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt index 35bb2044ab..fd9f8dc40c 100644 --- a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices getPrivateEndpoint Returns the connection state of the specified private endpoint. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The private endpoint service manages this private endpoint which belongs to one project hosted from one cloud service provider. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt index 6f80fd3e70..076e2c5565 100644 --- a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices getPrivateEndpointService Returns the name, interfaces, and state of the specified private endpoint service from one project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The cloud service provider hosted this private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt index 7ff1c0a731..3ac6848bab 100644 --- a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt +++ b/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices getRegionalizedPrivateEndpointSetting Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The cloud service provider manages the private endpoint for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt index 9ae804bf83..a30b6b234c 100644 --- a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt +++ b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices listPrivateEndpointServices Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt index d8c848c1c6..d69ea9ac9a 100644 --- a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt +++ b/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices toggleRegionalizedPrivateEndpointSetting Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-privateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices.txt index 198de73ae7..9b7fee3b8e 100644 --- a/docs/command/atlas-api-privateEndpointServices.txt +++ b/docs/command/atlas-api-privateEndpointServices.txt @@ -14,7 +14,7 @@ atlas api privateEndpointServices Returns, adds, edits, and removes private endpoint services. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt index f6caeddc6d..7b803f9653 100644 --- a/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys addProjectApiKey Assigns the specified organization API key to the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt index 482e04c820..a3f3f9d914 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys createApiKey Creates one API key for the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt index af2c7ebad4..f5100436fd 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys createApiKeyAccessList Creates the access list entries for the specified organization API key. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. diff --git a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt index 31cf4e93d9..633c5dc234 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys createProjectApiKey Creates and assigns the specified organization API key to the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt index b4cb42ecd3..85d46ab6d4 100644 --- a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys deleteApiKey Removes one organization API key from the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt index b4e2d5347b..b5bfbbee8b 100644 --- a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt +++ b/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys deleteApiKeyAccessListEntry Removes the specified access list entry from the specified organization API key. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt index 60b652425d..79e34f8bdd 100644 --- a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys getApiKey Returns one organization API key. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt index 7cbb5d4be4..956814a60b 100644 --- a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt +++ b/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys getApiKeyAccessList Returns one access list entry for the specified organization API key. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt index c70db42f8d..580983d22c 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys listApiKeyAccessListsEntries Returns all access list entries that you configured for the specified organization API key. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt index d4d3e85e1e..8f84b2a326 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys listApiKeys Returns all organization API keys for the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt index a2a673e33a..8b0d977a7e 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys listProjectApiKeys Returns all organization API keys that you assigned to the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt index d5d32ff48a..4d84f78083 100644 --- a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys removeProjectApiKey Removes one organization API key from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt index 1947e03709..d027878166 100644 --- a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys updateApiKey Updates one organization API key in the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The organization API keys grant programmatic access to an organization. To use this resource, the requesting API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt index f2b8c4513e..7321faca95 100644 --- a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt +++ b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys updateApiKeyRoles Updates the roles of the organization API key that you specify for the project that you specify. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-programmaticApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys.txt index 832ca6039e..1b5794a72e 100644 --- a/docs/command/atlas-api-programmaticApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys.txt @@ -14,7 +14,7 @@ atlas api programmaticApiKeys Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project. diff --git a/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt index 9330d19852..f19fb24a3b 100644 --- a/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt @@ -14,7 +14,7 @@ atlas api projectIpAccessList createProjectIpAccessList Adds one or more access list entries to the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent POST requests. You must submit multiple POST requests synchronously. diff --git a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt index d555a96e99..1640f13962 100644 --- a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt @@ -14,7 +14,7 @@ atlas api projectIpAccessList deleteProjectIpAccessList Removes one access list entry from the specified project's IP access list. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt index b8db7093f7..c25c46eda8 100644 --- a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt +++ b/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt @@ -14,7 +14,7 @@ atlas api projectIpAccessList getProjectIpAccessListStatus Returns the status of one project IP access list entry. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt index d8c441affb..0f6656154f 100644 --- a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt +++ b/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt @@ -14,7 +14,7 @@ atlas api projectIpAccessList getProjectIpList Returns one access list entry from the specified project's IP access list. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. This endpoint (/groups/{GROUP-ID}/accessList) manages the Project IP Access List. It doesn't manage the access list for MongoDB Cloud organizations. TheProgrammatic API Keys endpoint (/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist) manages those access lists. diff --git a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt b/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt index 8bbeba05a9..04cb9c2dab 100644 --- a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt +++ b/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt @@ -14,7 +14,7 @@ atlas api projectIpAccessList listProjectIpAccessLists Returns all access list entries from the specified project's IP access list. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-projectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList.txt index 88816f2317..282a9ad05f 100644 --- a/docs/command/atlas-api-projectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList.txt @@ -14,7 +14,7 @@ atlas api projectIpAccessList Returns, adds, edits, and removes network access limits to database deployments in Atlas. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This resource replaces the whitelist resource. Atlas removed whitelists in July 2021. Update your applications to use this new resource. This resource manages a project's IP Access List and supports creating temporary Access List entries that automatically expire within a user-configurable 7-day period. diff --git a/docs/command/atlas-api-projects-addUserToProject.txt b/docs/command/atlas-api-projects-addUserToProject.txt index 19c4c42d23..a06b90336f 100644 --- a/docs/command/atlas-api-projects-addUserToProject.txt +++ b/docs/command/atlas-api-projects-addUserToProject.txt @@ -14,7 +14,7 @@ atlas api projects addUserToProject Adds one MongoDB Cloud user to the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. diff --git a/docs/command/atlas-api-projects-createProject.txt b/docs/command/atlas-api-projects-createProject.txt index c4680f999a..354dfe99ba 100644 --- a/docs/command/atlas-api-projects-createProject.txt +++ b/docs/command/atlas-api-projects-createProject.txt @@ -14,7 +14,7 @@ atlas api projects createProject Creates one project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Read Write role. diff --git a/docs/command/atlas-api-projects-createProjectInvitation.txt b/docs/command/atlas-api-projects-createProjectInvitation.txt index ac90ab4983..eaaef5e31c 100644 --- a/docs/command/atlas-api-projects-createProjectInvitation.txt +++ b/docs/command/atlas-api-projects-createProjectInvitation.txt @@ -14,7 +14,7 @@ atlas api projects createProjectInvitation Invites one MongoDB Cloud user to join the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-deleteProject.txt b/docs/command/atlas-api-projects-deleteProject.txt index 7804600ed4..f089a39341 100644 --- a/docs/command/atlas-api-projects-deleteProject.txt +++ b/docs/command/atlas-api-projects-deleteProject.txt @@ -14,7 +14,7 @@ atlas api projects deleteProject Removes the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-deleteProjectInvitation.txt b/docs/command/atlas-api-projects-deleteProjectInvitation.txt index 1fc358c4dc..e005b6f627 100644 --- a/docs/command/atlas-api-projects-deleteProjectInvitation.txt +++ b/docs/command/atlas-api-projects-deleteProjectInvitation.txt @@ -14,7 +14,7 @@ atlas api projects deleteProjectInvitation Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can't cancel an invitation that the user accepted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-deleteProjectLimit.txt b/docs/command/atlas-api-projects-deleteProjectLimit.txt index 22a77a70d0..0cb36fd223 100644 --- a/docs/command/atlas-api-projects-deleteProjectLimit.txt +++ b/docs/command/atlas-api-projects-deleteProjectLimit.txt @@ -14,7 +14,7 @@ atlas api projects deleteProjectLimit Removes the specified project limit. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-getProject.txt b/docs/command/atlas-api-projects-getProject.txt index f9d35f4162..fc08652440 100644 --- a/docs/command/atlas-api-projects-getProject.txt +++ b/docs/command/atlas-api-projects-getProject.txt @@ -14,7 +14,7 @@ atlas api projects getProject Returns details about the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-projects-getProjectByName.txt b/docs/command/atlas-api-projects-getProjectByName.txt index 25796fd130..d0588bfc4c 100644 --- a/docs/command/atlas-api-projects-getProjectByName.txt +++ b/docs/command/atlas-api-projects-getProjectByName.txt @@ -14,7 +14,7 @@ atlas api projects getProjectByName Returns details about the project identified by its name. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-projects-getProjectInvitation.txt b/docs/command/atlas-api-projects-getProjectInvitation.txt index e979d9dbcd..553e8f5da3 100644 --- a/docs/command/atlas-api-projects-getProjectInvitation.txt +++ b/docs/command/atlas-api-projects-getProjectInvitation.txt @@ -14,7 +14,7 @@ atlas api projects getProjectInvitation Returns the details of one pending invitation to the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-getProjectLimit.txt b/docs/command/atlas-api-projects-getProjectLimit.txt index 40fe43f7a2..ed3ffbd91c 100644 --- a/docs/command/atlas-api-projects-getProjectLimit.txt +++ b/docs/command/atlas-api-projects-getProjectLimit.txt @@ -14,7 +14,7 @@ atlas api projects getProjectLimit Returns the specified limit for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-projects-getProjectLtsVersions.txt b/docs/command/atlas-api-projects-getProjectLtsVersions.txt index cc7b2d354a..0a91bf333e 100644 --- a/docs/command/atlas-api-projects-getProjectLtsVersions.txt +++ b/docs/command/atlas-api-projects-getProjectLtsVersions.txt @@ -14,7 +14,7 @@ atlas api projects getProjectLtsVersions Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getprojectltsversions. diff --git a/docs/command/atlas-api-projects-getProjectSettings.txt b/docs/command/atlas-api-projects-getProjectSettings.txt index 08e2a96b4c..3c92c54c1f 100644 --- a/docs/command/atlas-api-projects-getProjectSettings.txt +++ b/docs/command/atlas-api-projects-getProjectSettings.txt @@ -14,7 +14,7 @@ atlas api projects getProjectSettings Returns details about the specified project's settings. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-projects-listProjectInvitations.txt b/docs/command/atlas-api-projects-listProjectInvitations.txt index c971dc1d56..b92bc22a3c 100644 --- a/docs/command/atlas-api-projects-listProjectInvitations.txt +++ b/docs/command/atlas-api-projects-listProjectInvitations.txt @@ -14,7 +14,7 @@ atlas api projects listProjectInvitations Returns all pending invitations to the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-listProjectLimits.txt b/docs/command/atlas-api-projects-listProjectLimits.txt index b65562cf7f..3486503d86 100644 --- a/docs/command/atlas-api-projects-listProjectLimits.txt +++ b/docs/command/atlas-api-projects-listProjectLimits.txt @@ -14,7 +14,7 @@ atlas api projects listProjectLimits Returns all the limits for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-projects-listProjects.txt b/docs/command/atlas-api-projects-listProjects.txt index b7d36ace66..8a121ef71e 100644 --- a/docs/command/atlas-api-projects-listProjects.txt +++ b/docs/command/atlas-api-projects-listProjects.txt @@ -14,7 +14,7 @@ atlas api projects listProjects Returns details about all projects. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt b/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt index 8333e11cfc..11c5a67c8e 100644 --- a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt +++ b/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt @@ -14,7 +14,7 @@ atlas api projects migrateProjectToAnotherOrg Migrates a project from its current organization to another organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-projects-returnAllIpAddresses.txt b/docs/command/atlas-api-projects-returnAllIpAddresses.txt index 9cc1140837..21c58e2a62 100644 --- a/docs/command/atlas-api-projects-returnAllIpAddresses.txt +++ b/docs/command/atlas-api-projects-returnAllIpAddresses.txt @@ -14,7 +14,7 @@ atlas api projects returnAllIpAddresses Returns all IP addresses for this project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-projects-setProjectLimit.txt b/docs/command/atlas-api-projects-setProjectLimit.txt index 95da3e6c2c..f9356407d7 100644 --- a/docs/command/atlas-api-projects-setProjectLimit.txt +++ b/docs/command/atlas-api-projects-setProjectLimit.txt @@ -14,7 +14,7 @@ atlas api projects setProjectLimit Sets the specified project limit. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-updateProject.txt b/docs/command/atlas-api-projects-updateProject.txt index fdd5c49fb6..2efd3e7a1d 100644 --- a/docs/command/atlas-api-projects-updateProject.txt +++ b/docs/command/atlas-api-projects-updateProject.txt @@ -14,7 +14,7 @@ atlas api projects updateProject Updates the human-readable label that identifies the specified project, or the tags associated with the project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-updateProjectInvitation.txt b/docs/command/atlas-api-projects-updateProjectInvitation.txt index 8dcf58b5a3..fd567eea51 100644 --- a/docs/command/atlas-api-projects-updateProjectInvitation.txt +++ b/docs/command/atlas-api-projects-updateProjectInvitation.txt @@ -14,7 +14,7 @@ atlas api projects updateProjectInvitation Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-updateProjectInvitationById.txt b/docs/command/atlas-api-projects-updateProjectInvitationById.txt index 6d15d9b9ea..3533e3db99 100644 --- a/docs/command/atlas-api-projects-updateProjectInvitationById.txt +++ b/docs/command/atlas-api-projects-updateProjectInvitationById.txt @@ -14,7 +14,7 @@ atlas api projects updateProjectInvitationById Updates the details of one pending invitation, identified by its unique ID, to the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects-updateProjectRoles.txt b/docs/command/atlas-api-projects-updateProjectRoles.txt index e99660b40b..552623a20a 100644 --- a/docs/command/atlas-api-projects-updateProjectRoles.txt +++ b/docs/command/atlas-api-projects-updateProjectRoles.txt @@ -14,7 +14,7 @@ atlas api projects updateProjectRoles Updates the roles of the specified user in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting Service Account or API Key must have the Group User Admin role. diff --git a/docs/command/atlas-api-projects-updateProjectSettings.txt b/docs/command/atlas-api-projects-updateProjectSettings.txt index cc7f63fa82..91aace163f 100644 --- a/docs/command/atlas-api-projects-updateProjectSettings.txt +++ b/docs/command/atlas-api-projects-updateProjectSettings.txt @@ -14,7 +14,7 @@ atlas api projects updateProjectSettings Updates the settings of the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-projects.txt b/docs/command/atlas-api-projects.txt index a7392364a6..94c4c3ea3f 100644 --- a/docs/command/atlas-api-projects.txt +++ b/docs/command/atlas-api-projects.txt @@ -14,7 +14,7 @@ atlas api projects Returns, adds, and edits collections of clusters and users in MongoDB Cloud. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt index b3b11571ff..78e89674f5 100644 --- a/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt @@ -14,7 +14,7 @@ atlas api pushBasedLogExport createPushBasedLogConfiguration Configures the project level settings for the push-based log export feature. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-createpushbasedlogconfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt index bf5b231264..9844d810f6 100644 --- a/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt @@ -14,7 +14,7 @@ atlas api pushBasedLogExport deletePushBasedLogConfiguration Disables the push-based log export feature by resetting the project level settings to its default configuration. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-deletepushbasedlogconfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt index b5c4523817..3243450d60 100644 --- a/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt @@ -14,7 +14,7 @@ atlas api pushBasedLogExport getPushBasedLogConfiguration Fetches the current project level settings for the push-based log export feature. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getpushbasedlogconfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt index c3b6e3ba4e..a4dd0d2571 100644 --- a/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt @@ -14,7 +14,7 @@ atlas api pushBasedLogExport updatePushBasedLogConfiguration Updates the project level settings for the push-based log export feature. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-updatepushbasedlogconfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport.txt b/docs/command/atlas-api-pushBasedLogExport.txt index 31b2e37cf2..5852f296a8 100644 --- a/docs/command/atlas-api-pushBasedLogExport.txt +++ b/docs/command/atlas-api-pushBasedLogExport.txt @@ -14,7 +14,7 @@ atlas api pushBasedLogExport You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Atlas exports logs every 5 minutes. diff --git a/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt b/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt index 31b72ef023..eede754838 100644 --- a/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt +++ b/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt @@ -14,7 +14,7 @@ atlas api queryShapeInsights getGroupClusterQueryShapeInsightDetails Returns the metadata and statistics summary for a given query shape hash. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getgroupclusterqueryshapeinsightdetails. diff --git a/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries.txt b/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries.txt index 7fa108bd5c..4b8e66972b 100644 --- a/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries.txt +++ b/docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries.txt @@ -14,7 +14,7 @@ atlas api queryShapeInsights getGroupClusterQueryShapeInsightSummaries Returns a list of query shape statistics summaries for a given cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Query shape statistics provide performance insights about MongoDB queries, helping users identify problematic query patterns and potential optimizations. diff --git a/docs/command/atlas-api-queryShapeInsights.txt b/docs/command/atlas-api-queryShapeInsights.txt index 8cbf6fe330..f979c8f7d2 100644 --- a/docs/command/atlas-api-queryShapeInsights.txt +++ b/docs/command/atlas-api-queryShapeInsights.txt @@ -14,7 +14,7 @@ atlas api queryShapeInsights -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-resourcePolicies-createOrgResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-createOrgResourcePolicy.txt index fa35ac286e..056a2cdbe1 100644 --- a/docs/command/atlas-api-resourcePolicies-createOrgResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-createOrgResourcePolicy.txt @@ -14,7 +14,7 @@ atlas api resourcePolicies createOrgResourcePolicy Create one Atlas Resource Policy for an org. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-createorgresourcepolicy. diff --git a/docs/command/atlas-api-resourcePolicies-deleteOrgResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-deleteOrgResourcePolicy.txt index edb09e9238..e37c8eb78b 100644 --- a/docs/command/atlas-api-resourcePolicies-deleteOrgResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-deleteOrgResourcePolicy.txt @@ -14,7 +14,7 @@ atlas api resourcePolicies deleteOrgResourcePolicy Delete one Atlas Resource Policy for an org. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-deleteorgresourcepolicy. diff --git a/docs/command/atlas-api-resourcePolicies-getOrgResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-getOrgResourcePolicy.txt index 59090e50dc..533581db43 100644 --- a/docs/command/atlas-api-resourcePolicies-getOrgResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-getOrgResourcePolicy.txt @@ -14,7 +14,7 @@ atlas api resourcePolicies getOrgResourcePolicy Return one Atlas Resource Policy for an org. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getorgresourcepolicy. diff --git a/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt b/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt index d2b57b2f29..1e220f8792 100644 --- a/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt +++ b/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt @@ -14,7 +14,7 @@ atlas api resourcePolicies getResourcesNonCompliant Return all non-compliant resources for an org. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getresourcesnoncompliant. diff --git a/docs/command/atlas-api-resourcePolicies-listOrgResourcePolicies.txt b/docs/command/atlas-api-resourcePolicies-listOrgResourcePolicies.txt index b950d73b05..3c92d4ba4a 100644 --- a/docs/command/atlas-api-resourcePolicies-listOrgResourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies-listOrgResourcePolicies.txt @@ -14,7 +14,7 @@ atlas api resourcePolicies listOrgResourcePolicies Return all Atlas Resource Policies for the org. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-listorgresourcepolicies. diff --git a/docs/command/atlas-api-resourcePolicies-updateOrgResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-updateOrgResourcePolicy.txt index 78b3321452..cf9372891b 100644 --- a/docs/command/atlas-api-resourcePolicies-updateOrgResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-updateOrgResourcePolicy.txt @@ -14,7 +14,7 @@ atlas api resourcePolicies updateOrgResourcePolicy Update one Atlas Resource Policy for an org. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-updateorgresourcepolicy. diff --git a/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt index e014058cd3..23b2e1f12a 100644 --- a/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt @@ -14,7 +14,7 @@ atlas api resourcePolicies validateAtlasResourcePolicy Validate one Atlas Resource Policy for an org. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-validateatlasresourcepolicy. diff --git a/docs/command/atlas-api-resourcePolicies.txt b/docs/command/atlas-api-resourcePolicies.txt index d124b01903..57642ed6ce 100644 --- a/docs/command/atlas-api-resourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies.txt @@ -14,7 +14,7 @@ atlas api resourcePolicies Configure and manage Atlas Resource Policies within your organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-rollingIndex-createRollingIndex.txt b/docs/command/atlas-api-rollingIndex-createRollingIndex.txt index 24484fa85d..34385577d6 100644 --- a/docs/command/atlas-api-rollingIndex-createRollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex-createRollingIndex.txt @@ -14,7 +14,7 @@ atlas api rollingIndex createRollingIndex Creates an index on the cluster identified by its name in a rolling manner. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. diff --git a/docs/command/atlas-api-rollingIndex.txt b/docs/command/atlas-api-rollingIndex.txt index d00329ce6c..9f47a418b0 100644 --- a/docs/command/atlas-api-rollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex.txt @@ -14,7 +14,7 @@ atlas api rollingIndex Creates one index to a database deployment in a rolling manner. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-root-getSystemStatus.txt b/docs/command/atlas-api-root-getSystemStatus.txt index e75299640b..65932a1834 100644 --- a/docs/command/atlas-api-root-getSystemStatus.txt +++ b/docs/command/atlas-api-root-getSystemStatus.txt @@ -14,7 +14,7 @@ atlas api root getSystemStatus This resource returns information about the MongoDB application along with API key meta data. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getsystemstatus. diff --git a/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt b/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt index 1f6221a884..14ba546e28 100644 --- a/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt +++ b/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt @@ -14,7 +14,7 @@ atlas api root returnAllControlPlaneIpAddresses Returns all control plane IP addresses. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-returnallcontrolplaneipaddresses. diff --git a/docs/command/atlas-api-root.txt b/docs/command/atlas-api-root.txt index 99c4bda3e1..cbe1cda473 100644 --- a/docs/command/atlas-api-root.txt +++ b/docs/command/atlas-api-root.txt @@ -14,7 +14,7 @@ atlas api root Returns details that describe the MongoDB Cloud build and the access token that requests this resource. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This starts the MongoDB Cloud API. diff --git a/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt index cfbab604a6..bdefed526a 100644 --- a/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt @@ -14,7 +14,7 @@ atlas api serverlessInstances createServerlessInstance Update as of Feb 2025: This endpoint now creates a Flex cluster instead. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This endpoint will no longer be supported starting January 2026. Continuous backups are not supported and serverlessContinuousBackupEnabled will not take effect. Please use the createFlexCluster endpoint instead. diff --git a/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt index fe5f34cad7..fb0b0b75df 100644 --- a/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt @@ -14,7 +14,7 @@ atlas api serverlessInstances deleteServerlessInstance Removes one serverless instance from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt index 419b8065f3..7a909c7355 100644 --- a/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt @@ -14,7 +14,7 @@ atlas api serverlessInstances getServerlessInstance Returns details for one serverless instance in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt b/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt index 658d4daf43..06ecf43f28 100644 --- a/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt +++ b/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt @@ -14,7 +14,7 @@ atlas api serverlessInstances listServerlessInstances Returns details for all serverless instances in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt index f790e2147e..b24c54f7d8 100644 --- a/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt @@ -14,7 +14,7 @@ atlas api serverlessInstances updateServerlessInstance Updates one serverless instance in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessInstances.txt b/docs/command/atlas-api-serverlessInstances.txt index e01749f5ea..f9e76f55c6 100644 --- a/docs/command/atlas-api-serverlessInstances.txt +++ b/docs/command/atlas-api-serverlessInstances.txt @@ -14,7 +14,7 @@ atlas api serverlessInstances Returns, adds, edits, and removes serverless instances. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt index f13bd1c7fe..d79be2bebd 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api serverlessPrivateEndpoints createServerlessPrivateEndpoint Creates one private endpoint for one serverless instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt index d77d8cc87d..55697287b7 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api serverlessPrivateEndpoints deleteServerlessPrivateEndpoint Remove one private endpoint from one serverless instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt index 1625751472..a8ca642b19 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint Return one private endpoint for one serverless instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt index a4f8bb425d..abb96d5f51 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt @@ -14,7 +14,7 @@ atlas api serverlessPrivateEndpoints listServerlessPrivateEndpoints Returns all private endpoints for one serverless instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You must have at least the Project Read Only role for the project to successfully call this resource. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt index 86e533e689..8ca0a9b335 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt @@ -14,7 +14,7 @@ atlas api serverlessPrivateEndpoints updateServerlessPrivateEndpoint Updates one private endpoint for one serverless instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints.txt b/docs/command/atlas-api-serverlessPrivateEndpoints.txt index 6340ff98aa..89bb697146 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints.txt @@ -14,7 +14,7 @@ atlas api serverlessPrivateEndpoints Returns, adds, edits, and removes private endpoints for serverless instances. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To learn more, see the Atlas Administration API tab on the following tutorial. diff --git a/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt index e3e73537da..58fde47ab6 100644 --- a/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts addProjectServiceAccount Assigns the specified Service Account to the specified Project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-addprojectserviceaccount. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt index af6842feeb..dd9496e8ba 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts createProjectServiceAccount Creates one Service Account for the specified Project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt index 6baac0e201..26dd35f084 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts createProjectServiceAccountAccessList Add Access List Entries for the specified Service Account for the project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Resources require all API requests to originate from IP addresses on the API access list. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt index 1247ec87c9..e52df35153 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts createProjectServiceAccountSecret Create a secret for the specified Service Account in the specified Project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-createprojectserviceaccountsecret. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt index e03fe17618..3b26488f5a 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts createServiceAccount Creates one Service Account for the specified Organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-createserviceaccount. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt index 1894076f8b..aa3169f963 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts createServiceAccountAccessList Add Access List Entries for the specified Service Account for the organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Resources require all API requests to originate from IP addresses on the API access list. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt index cc20908c00..00a58fc67c 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts createServiceAccountSecret Create a secret for the specified Service Account. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-createserviceaccountsecret. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt index 30ffbe4af9..3adb2cdfc0 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts deleteProjectServiceAccount Removes the specified Service Account from the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. The Service Account will still be a part of the Organization it was created in, and the credentials will remain active until expired or manually revoked. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt index af88dddd78..a2a096f049 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts deleteProjectServiceAccountAccessListEntry Removes the specified access list entry from the specified Service Account for the project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can't remove the requesting IP address from the access list. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt index b906a062fe..24488475ac 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts deleteProjectServiceAccountSecret Deletes the specified Service Account secret. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-deleteprojectserviceaccountsecret. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt index dc8be5ca12..dcff78c2df 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts deleteServiceAccount Deletes the specified Service Account. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-deleteserviceaccount. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt index 4e5afea548..1128ed1b26 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts deleteServiceAccountAccessListEntry Removes the specified access list entry from the specified Service Account for the organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can't remove the requesting IP address from the access list. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt index 069515646c..b424186d49 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts deleteServiceAccountSecret Deletes the specified Service Account secret. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-deleteserviceaccountsecret. diff --git a/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt index 65614cdafb..3432db49ff 100644 --- a/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts getProjectServiceAccount Returns one Service Account in the specified Project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getprojectserviceaccount. diff --git a/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt index 58455e4688..39dace91c5 100644 --- a/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts getServiceAccount Returns the specified Service Account. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getserviceaccount. diff --git a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt index baaa00ea6c..429cafc6a8 100644 --- a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts listProjectServiceAccountAccessList Returns all access list entries that you configured for the specified Service Account for the project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-listprojectserviceaccountaccesslist. diff --git a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt index 91f14a2506..37f03ab638 100644 --- a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts listProjectServiceAccounts Returns all Service Accounts for the specified Project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-listprojectserviceaccounts. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt index c7cc6ab266..062ade9b33 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts listServiceAccountAccessList Returns all access list entries that you configured for the specified Service Account for the organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-listserviceaccountaccesslist. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt index d18b44a5c3..144a779669 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts listServiceAccountProjects Returns a list of all projects the specified Service Account is a part of. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-listserviceaccountprojects. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt index 8d32a989cc..0bf1581411 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts listServiceAccounts Returns all Service Accounts for the specified Organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-listserviceaccounts. diff --git a/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt index b2ae2a4245..e8f26c8ecc 100644 --- a/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts updateProjectServiceAccount Updates one Service Account in the specified Project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-updateprojectserviceaccount. diff --git a/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt index 26b69db158..a037461272 100644 --- a/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts updateServiceAccount Updates the specified Service Account in the specified Organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-updateserviceaccount. diff --git a/docs/command/atlas-api-serviceAccounts.txt b/docs/command/atlas-api-serviceAccounts.txt index 947cce9972..0aaf47ef7a 100644 --- a/docs/command/atlas-api-serviceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts.txt @@ -14,7 +14,7 @@ atlas api serviceAccounts Endpoints for managing Service Accounts and secrets. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow. diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt b/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt index 367ead3cd2..a185194296 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api sharedTierRestoreJobs createSharedClusterBackupRestoreJob Restores the specified M2 or M5 cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt b/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt index 138c5d5555..40bf79d2be 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt @@ -14,7 +14,7 @@ atlas api sharedTierRestoreJobs getSharedClusterBackupRestoreJob Returns the specified restore job for the specified M2 or M5 cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt b/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt index b8c7f326a3..647ee36461 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt @@ -14,7 +14,7 @@ atlas api sharedTierRestoreJobs listSharedClusterBackupRestoreJobs Returns all restore jobs for the specified M2 or M5 cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-sharedTierRestoreJobs.txt b/docs/command/atlas-api-sharedTierRestoreJobs.txt index d78199219e..4f1481144c 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs.txt @@ -14,7 +14,7 @@ atlas api sharedTierRestoreJobs Returns and adds restore jobs for shared-tier database deployments. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt b/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt index d3b00c96c6..b7c98a5fa1 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt @@ -14,7 +14,7 @@ atlas api sharedTierSnapshots downloadSharedClusterBackup Requests one snapshot for the specified shared cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt b/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt index cbeac7cba8..d10dbfaeb4 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt @@ -14,7 +14,7 @@ atlas api sharedTierSnapshots getSharedClusterBackup Returns details for one snapshot for the specified shared cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt b/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt index 053868d3d4..676159a80f 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt @@ -14,7 +14,7 @@ atlas api sharedTierSnapshots listSharedClusterBackups Returns details for all snapshots for the specified shared cluster. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-sharedTierSnapshots.txt b/docs/command/atlas-api-sharedTierSnapshots.txt index 046a4697ed..f9c891ac90 100644 --- a/docs/command/atlas-api-sharedTierSnapshots.txt +++ b/docs/command/atlas-api-sharedTierSnapshots.txt @@ -14,7 +14,7 @@ atlas api sharedTierSnapshots Returns and requests to download shared-tier database deployment snapshots. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt b/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt index 048acd19b1..19ed19a8d2 100644 --- a/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt @@ -14,7 +14,7 @@ atlas api streams acceptVpcPeeringConnection Requests the acceptance of an incoming VPC Peering connection. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-acceptvpcpeeringconnection. diff --git a/docs/command/atlas-api-streams-createPrivateLinkConnection.txt b/docs/command/atlas-api-streams-createPrivateLinkConnection.txt index 04937ef12d..d7b844fac1 100644 --- a/docs/command/atlas-api-streams-createPrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-createPrivateLinkConnection.txt @@ -14,7 +14,7 @@ atlas api streams createPrivateLinkConnection Creates one Private Link in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-createStreamConnection.txt b/docs/command/atlas-api-streams-createStreamConnection.txt index ab0f87d430..9eea603ec5 100644 --- a/docs/command/atlas-api-streams-createStreamConnection.txt +++ b/docs/command/atlas-api-streams-createStreamConnection.txt @@ -14,7 +14,7 @@ atlas api streams createStreamConnection Creates one connection for a stream instance in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-createStreamInstance.txt b/docs/command/atlas-api-streams-createStreamInstance.txt index b4008fe123..11d4a3541e 100644 --- a/docs/command/atlas-api-streams-createStreamInstance.txt +++ b/docs/command/atlas-api-streams-createStreamInstance.txt @@ -14,7 +14,7 @@ atlas api streams createStreamInstance Creates one stream instance in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt b/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt index dda8a9a34c..fb493de421 100644 --- a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt +++ b/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt @@ -14,7 +14,7 @@ atlas api streams createStreamInstanceWithSampleConnections Creates one stream instance in the specified project with sample connections. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-createStreamProcessor.txt b/docs/command/atlas-api-streams-createStreamProcessor.txt index 1e923f9191..0e23fd971e 100644 --- a/docs/command/atlas-api-streams-createStreamProcessor.txt +++ b/docs/command/atlas-api-streams-createStreamProcessor.txt @@ -14,7 +14,7 @@ atlas api streams createStreamProcessor Create one Stream Processor within the specified stream instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt index d431b3651b..6447e7bd58 100644 --- a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt @@ -14,7 +14,7 @@ atlas api streams deletePrivateLinkConnection Deletes one Private Link in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-deleteStreamConnection.txt b/docs/command/atlas-api-streams-deleteStreamConnection.txt index ff056ecb20..5bb124b7e7 100644 --- a/docs/command/atlas-api-streams-deleteStreamConnection.txt +++ b/docs/command/atlas-api-streams-deleteStreamConnection.txt @@ -14,7 +14,7 @@ atlas api streams deleteStreamConnection Delete one connection of the specified stream instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-deleteStreamInstance.txt b/docs/command/atlas-api-streams-deleteStreamInstance.txt index 1369900e34..dd5fe54897 100644 --- a/docs/command/atlas-api-streams-deleteStreamInstance.txt +++ b/docs/command/atlas-api-streams-deleteStreamInstance.txt @@ -14,7 +14,7 @@ atlas api streams deleteStreamInstance Delete one stream instance in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-deleteStreamProcessor.txt b/docs/command/atlas-api-streams-deleteStreamProcessor.txt index 06932cfe64..ae37f7994a 100644 --- a/docs/command/atlas-api-streams-deleteStreamProcessor.txt +++ b/docs/command/atlas-api-streams-deleteStreamProcessor.txt @@ -14,7 +14,7 @@ atlas api streams deleteStreamProcessor Delete a Stream Processor within the specified stream instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt index 1a97c5f5ad..8dde6ccf82 100644 --- a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt @@ -14,7 +14,7 @@ atlas api streams deleteVpcPeeringConnection Deletes an incoming VPC Peering connection. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-deletevpcpeeringconnection. diff --git a/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt b/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt index 674097e5c6..f5efa38744 100644 --- a/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt +++ b/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt @@ -14,7 +14,7 @@ atlas api streams downloadStreamTenantAuditLogs Downloads the audit logs for the specified Atlas Streams Processing instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. By default, logs cover periods of 30 days. To use this resource, the requesting Service Account or API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". diff --git a/docs/command/atlas-api-streams-getAccountDetails.txt b/docs/command/atlas-api-streams-getAccountDetails.txt index c0823e168d..75c5562355 100644 --- a/docs/command/atlas-api-streams-getAccountDetails.txt +++ b/docs/command/atlas-api-streams-getAccountDetails.txt @@ -14,7 +14,7 @@ atlas api streams getAccountDetails Returns the Account ID, and the VPC ID for the group and region specified. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getaccountdetails. diff --git a/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt index e55c4728e6..06e9fb6ec8 100644 --- a/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt +++ b/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt @@ -14,7 +14,7 @@ atlas api streams getActiveVpcPeeringConnections Returns a list of active incoming VPC Peering Connections. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getactivevpcpeeringconnections. diff --git a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt index f5e92532de..41f3aa6da8 100644 --- a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt @@ -14,7 +14,7 @@ atlas api streams getPrivateLinkConnection Returns the details of one Private Link connection within the project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-streams-getStreamConnection.txt b/docs/command/atlas-api-streams-getStreamConnection.txt index 5d084f3e96..b6178537c7 100644 --- a/docs/command/atlas-api-streams-getStreamConnection.txt +++ b/docs/command/atlas-api-streams-getStreamConnection.txt @@ -14,7 +14,7 @@ atlas api streams getStreamConnection Returns the details of one stream connection within the specified stream instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-streams-getStreamInstance.txt b/docs/command/atlas-api-streams-getStreamInstance.txt index 5c6e96a27b..4b3722f677 100644 --- a/docs/command/atlas-api-streams-getStreamInstance.txt +++ b/docs/command/atlas-api-streams-getStreamInstance.txt @@ -14,7 +14,7 @@ atlas api streams getStreamInstance Returns the details of one stream instance within the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-streams-getStreamProcessor.txt b/docs/command/atlas-api-streams-getStreamProcessor.txt index f32b796cfd..0140ba1874 100644 --- a/docs/command/atlas-api-streams-getStreamProcessor.txt +++ b/docs/command/atlas-api-streams-getStreamProcessor.txt @@ -14,7 +14,7 @@ atlas api streams getStreamProcessor Get one Stream Processor within the specified stream instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getVpcPeeringConnections.txt index b7f905c5c7..804c35958f 100644 --- a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt +++ b/docs/command/atlas-api-streams-getVpcPeeringConnections.txt @@ -14,7 +14,7 @@ atlas api streams getVpcPeeringConnections Returns a list of incoming VPC Peering Connections. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-getvpcpeeringconnections. diff --git a/docs/command/atlas-api-streams-listPrivateLinkConnections.txt b/docs/command/atlas-api-streams-listPrivateLinkConnections.txt index 816253e128..834d39139c 100644 --- a/docs/command/atlas-api-streams-listPrivateLinkConnections.txt +++ b/docs/command/atlas-api-streams-listPrivateLinkConnections.txt @@ -14,7 +14,7 @@ atlas api streams listPrivateLinkConnections Returns all Private Link connections for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-listStreamConnections.txt b/docs/command/atlas-api-streams-listStreamConnections.txt index 7195c421fb..06156f154f 100644 --- a/docs/command/atlas-api-streams-listStreamConnections.txt +++ b/docs/command/atlas-api-streams-listStreamConnections.txt @@ -14,7 +14,7 @@ atlas api streams listStreamConnections Returns all connections of the stream instance for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-listStreamInstances.txt b/docs/command/atlas-api-streams-listStreamInstances.txt index 4f99bcbee5..1b55a66c69 100644 --- a/docs/command/atlas-api-streams-listStreamInstances.txt +++ b/docs/command/atlas-api-streams-listStreamInstances.txt @@ -14,7 +14,7 @@ atlas api streams listStreamInstances Returns all stream instances for the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-liststreaminstances. diff --git a/docs/command/atlas-api-streams-listStreamProcessors.txt b/docs/command/atlas-api-streams-listStreamProcessors.txt index 3c8ab7dfa6..8954460dc6 100644 --- a/docs/command/atlas-api-streams-listStreamProcessors.txt +++ b/docs/command/atlas-api-streams-listStreamProcessors.txt @@ -14,7 +14,7 @@ atlas api streams listStreamProcessors Returns all Stream Processors within the specified stream instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-modifyStreamProcessor.txt b/docs/command/atlas-api-streams-modifyStreamProcessor.txt index bf78e57b4e..63a1609798 100644 --- a/docs/command/atlas-api-streams-modifyStreamProcessor.txt +++ b/docs/command/atlas-api-streams-modifyStreamProcessor.txt @@ -14,7 +14,7 @@ atlas api streams modifyStreamProcessor Modify one existing Stream Processor within the specified stream instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt index c5091c3b51..d3e7a319b0 100644 --- a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt @@ -14,7 +14,7 @@ atlas api streams rejectVpcPeeringConnection Requests the rejection of an incoming VPC Peering connection. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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-rejectvpcpeeringconnection. diff --git a/docs/command/atlas-api-streams-startStreamProcessor.txt b/docs/command/atlas-api-streams-startStreamProcessor.txt index 3b1ff9a942..1856de29d9 100644 --- a/docs/command/atlas-api-streams-startStreamProcessor.txt +++ b/docs/command/atlas-api-streams-startStreamProcessor.txt @@ -14,7 +14,7 @@ atlas api streams startStreamProcessor Start a Stream Processor within the specified stream instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-startStreamProcessorWith.txt b/docs/command/atlas-api-streams-startStreamProcessorWith.txt index fb007a3b46..04eacc3ddb 100644 --- a/docs/command/atlas-api-streams-startStreamProcessorWith.txt +++ b/docs/command/atlas-api-streams-startStreamProcessorWith.txt @@ -14,7 +14,7 @@ atlas api streams startStreamProcessorWith Start a Stream Processor within the specified stream instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-stopStreamProcessor.txt b/docs/command/atlas-api-streams-stopStreamProcessor.txt index 4493133470..45891fb4be 100644 --- a/docs/command/atlas-api-streams-stopStreamProcessor.txt +++ b/docs/command/atlas-api-streams-stopStreamProcessor.txt @@ -14,7 +14,7 @@ atlas api streams stopStreamProcessor Stop a Stream Processor within the specified stream instance. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-updateStreamConnection.txt b/docs/command/atlas-api-streams-updateStreamConnection.txt index a0bec2f9bb..276c774a29 100644 --- a/docs/command/atlas-api-streams-updateStreamConnection.txt +++ b/docs/command/atlas-api-streams-updateStreamConnection.txt @@ -14,7 +14,7 @@ atlas api streams updateStreamConnection Update one connection for the specified stream instance in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams-updateStreamInstance.txt b/docs/command/atlas-api-streams-updateStreamInstance.txt index 7f3faf6a8c..d3d9085da0 100644 --- a/docs/command/atlas-api-streams-updateStreamInstance.txt +++ b/docs/command/atlas-api-streams-updateStreamInstance.txt @@ -14,7 +14,7 @@ atlas api streams updateStreamInstance Update one stream instance in the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. diff --git a/docs/command/atlas-api-streams.txt b/docs/command/atlas-api-streams.txt index 5a1648621b..2b22aa920f 100644 --- a/docs/command/atlas-api-streams.txt +++ b/docs/command/atlas-api-streams.txt @@ -14,7 +14,7 @@ atlas api streams Returns, adds, edits, and removes Streams Instances. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This resource requires your project ID. diff --git a/docs/command/atlas-api-teams-addAllTeamsToProject.txt b/docs/command/atlas-api-teams-addAllTeamsToProject.txt index 74e2f8ae20..8a51faf5d6 100644 --- a/docs/command/atlas-api-teams-addAllTeamsToProject.txt +++ b/docs/command/atlas-api-teams-addAllTeamsToProject.txt @@ -14,7 +14,7 @@ atlas api teams addAllTeamsToProject Adds one or more teams to the specified project. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. All members of the team share the same project access. MongoDB Cloud limits the number of users to a maximum of 100 teams per project and a maximum of 250 teams per organization. To use this resource, the requesting API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-teams-addTeamUser.txt b/docs/command/atlas-api-teams-addTeamUser.txt index b28f6d724a..dbc08f7f6e 100644 --- a/docs/command/atlas-api-teams-addTeamUser.txt +++ b/docs/command/atlas-api-teams-addTeamUser.txt @@ -14,7 +14,7 @@ atlas api teams addTeamUser Adds one or more MongoDB Cloud users from the specified organization to the specified team. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-teams-createTeam.txt b/docs/command/atlas-api-teams-createTeam.txt index d770e77f54..4d3b24fe4d 100644 --- a/docs/command/atlas-api-teams-createTeam.txt +++ b/docs/command/atlas-api-teams-createTeam.txt @@ -14,7 +14,7 @@ atlas api teams createTeam Creates one team in the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits the number of teams to a maximum of 250 teams per organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-teams-deleteTeam.txt b/docs/command/atlas-api-teams-deleteTeam.txt index 100acf505b..a2a7da6170 100644 --- a/docs/command/atlas-api-teams-deleteTeam.txt +++ b/docs/command/atlas-api-teams-deleteTeam.txt @@ -14,7 +14,7 @@ atlas api teams deleteTeam Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-teams-getProjectTeam.txt b/docs/command/atlas-api-teams-getProjectTeam.txt index d5db50c497..9c7fd1b8a9 100644 --- a/docs/command/atlas-api-teams-getProjectTeam.txt +++ b/docs/command/atlas-api-teams-getProjectTeam.txt @@ -14,7 +14,7 @@ atlas api teams getProjectTeam Returns one team to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-teams-getTeamById.txt b/docs/command/atlas-api-teams-getTeamById.txt index 2604fcdc63..1216358183 100644 --- a/docs/command/atlas-api-teams-getTeamById.txt +++ b/docs/command/atlas-api-teams-getTeamById.txt @@ -14,7 +14,7 @@ atlas api teams getTeamById Returns one team that you identified using its unique 24-hexadecimal digit ID. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-teams-getTeamByName.txt b/docs/command/atlas-api-teams-getTeamByName.txt index be218ac91a..94b095b0bc 100644 --- a/docs/command/atlas-api-teams-getTeamByName.txt +++ b/docs/command/atlas-api-teams-getTeamByName.txt @@ -14,7 +14,7 @@ atlas api teams getTeamByName Returns one team that you identified using its human-readable name. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-teams-listOrganizationTeams.txt b/docs/command/atlas-api-teams-listOrganizationTeams.txt index 78e2f4a4f6..209851b2e7 100644 --- a/docs/command/atlas-api-teams-listOrganizationTeams.txt +++ b/docs/command/atlas-api-teams-listOrganizationTeams.txt @@ -14,7 +14,7 @@ atlas api teams listOrganizationTeams Returns all teams that belong to the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. diff --git a/docs/command/atlas-api-teams-listProjectTeams.txt b/docs/command/atlas-api-teams-listProjectTeams.txt index bc88698817..fb5787fe69 100644 --- a/docs/command/atlas-api-teams-listProjectTeams.txt +++ b/docs/command/atlas-api-teams-listProjectTeams.txt @@ -14,7 +14,7 @@ atlas api teams listProjectTeams Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. 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. diff --git a/docs/command/atlas-api-teams-removeProjectTeam.txt b/docs/command/atlas-api-teams-removeProjectTeam.txt index 733be552c1..08a4b8ef23 100644 --- a/docs/command/atlas-api-teams-removeProjectTeam.txt +++ b/docs/command/atlas-api-teams-removeProjectTeam.txt @@ -14,7 +14,7 @@ atlas api teams removeProjectTeam Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-teams-removeTeamUser.txt b/docs/command/atlas-api-teams-removeTeamUser.txt index bfa0147576..526c12ade7 100644 --- a/docs/command/atlas-api-teams-removeTeamUser.txt +++ b/docs/command/atlas-api-teams-removeTeamUser.txt @@ -14,7 +14,7 @@ atlas api teams removeTeamUser Removes one MongoDB Cloud user from the specified team. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-teams-renameTeam.txt b/docs/command/atlas-api-teams-renameTeam.txt index e5ff4c343a..7786dc1127 100644 --- a/docs/command/atlas-api-teams-renameTeam.txt +++ b/docs/command/atlas-api-teams-renameTeam.txt @@ -14,7 +14,7 @@ atlas api teams renameTeam Renames one team in the specified organization. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. diff --git a/docs/command/atlas-api-teams-updateTeamRoles.txt b/docs/command/atlas-api-teams-updateTeamRoles.txt index de0c41af4e..ef254bd933 100644 --- a/docs/command/atlas-api-teams-updateTeamRoles.txt +++ b/docs/command/atlas-api-teams-updateTeamRoles.txt @@ -14,7 +14,7 @@ atlas api teams updateTeamRoles Updates the project roles assigned to the specified team. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-teams.txt b/docs/command/atlas-api-teams.txt index 84f2bb1077..b05cf1a891 100644 --- a/docs/command/atlas-api-teams.txt +++ b/docs/command/atlas-api-teams.txt @@ -14,7 +14,7 @@ atlas api teams Returns, adds, edits, or removes teams. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt index c9e7b3f3d7..d4ea050bb3 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt @@ -14,7 +14,7 @@ atlas api thirdPartyIntegrations createThirdPartyIntegration Adds the settings for configuring one third-party service integration. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. These settings apply to all databases managed in the specified MongoDB Cloud project. Each project can have only one configuration per {INTEGRATION-TYPE}. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt index 8eaeb5bb73..c8e130be5e 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt @@ -14,7 +14,7 @@ atlas api thirdPartyIntegrations deleteThirdPartyIntegration Removes the settings that permit configuring one third-party service integration. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured {INTEGRATION-TYPE} integrations. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt index c6b87ae1cc..77a2c46d92 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt @@ -14,7 +14,7 @@ atlas api thirdPartyIntegrations getThirdPartyIntegration Returns the settings for configuring integration with one third-party service. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt index 090c2bf614..091764ba6b 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt @@ -14,7 +14,7 @@ atlas api thirdPartyIntegrations listThirdPartyIntegrations Returns the settings that permit integrations with all configured third-party services. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt index bcc8c5329e..04135e528c 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt @@ -14,7 +14,7 @@ atlas api thirdPartyIntegrations updateThirdPartyIntegration Updates the settings for configuring integration with one third-party service. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. diff --git a/docs/command/atlas-api-thirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations.txt index b92814a915..a635ea0ed9 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations.txt @@ -14,7 +14,7 @@ atlas api thirdPartyIntegrations Returns, adds, edits, and removes third-party service integration configurations. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. MongoDB Cloud sends alerts to each third-party service that you configure. diff --git a/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt b/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt index a8753c3010..a7052de962 100644 --- a/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt +++ b/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt @@ -14,7 +14,7 @@ atlas api x509Authentication createDatabaseUserCertificate Generates one X.509 certificate for the specified MongoDB user. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. diff --git a/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt b/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt index 10804db52f..8ef2b8490c 100644 --- a/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt +++ b/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt @@ -14,7 +14,7 @@ atlas api x509Authentication disableCustomerManagedX509 Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint. diff --git a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt b/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt index 6cb3444da6..556cf2d3ce 100644 --- a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt +++ b/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt @@ -14,7 +14,7 @@ atlas api x509Authentication listDatabaseUserCertificates Returns all unexpired X.509 certificates for the specified MongoDB user. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-x509Authentication.txt b/docs/command/atlas-api-x509Authentication.txt index 2d8e940966..effc72448b 100644 --- a/docs/command/atlas-api-x509Authentication.txt +++ b/docs/command/atlas-api-x509Authentication.txt @@ -14,7 +14,7 @@ atlas api x509Authentication Returns, edits, and removes user-managed X.509 configurations. -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users. diff --git a/docs/command/atlas-api.txt b/docs/command/atlas-api.txt index 64ae77360f..2d7e2f9267 100644 --- a/docs/command/atlas-api.txt +++ b/docs/command/atlas-api.txt @@ -20,7 +20,7 @@ For more information on - Atlas Administration API see: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/ - Getting started with the Atlas Administration API: https://www.mongodb.com/docs/atlas/configure-api-access/#std-label-atlas-admin-api-access -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Syntax diff --git a/internal/cli/help_templates.go b/internal/cli/help_templates.go index cca770f3cd..807eb3f886 100644 --- a/internal/cli/help_templates.go +++ b/internal/cli/help_templates.go @@ -21,8 +21,8 @@ const ( {{if or .Runnable .HasSubCommands}}{{.UsageString}}{{end}}` - APICommandText = "The atlas api sub-command, " + - "automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.\n" + + APICommandText = "The atlas api sub-command " + + "is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API.\n" + "Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint " + "documentation link.\n\n" diff --git a/tools/cmd/docs/api_docs_long_text.txt b/tools/cmd/docs/api_docs_long_text.txt index 4e87233b66..4f20d5079c 100644 --- a/tools/cmd/docs/api_docs_long_text.txt +++ b/tools/cmd/docs/api_docs_long_text.txt @@ -1,4 +1,4 @@ -The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API. +The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. Syntax From fdca45e45840f0fce17f5fb951df15cb4793471d Mon Sep 17 00:00:00 2001 From: Luke Sanderson <94322623+Luke-Sanderson@users.noreply.github.com> Date: Mon, 6 Oct 2025 13:00:55 +0100 Subject: [PATCH 09/11] Docs comments Co-authored-by: kanchana-mongodb <54281287+kanchana-mongodb@users.noreply.github.com> --- internal/cli/api/api.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/cli/api/api.go b/internal/cli/api/api.go index 68d13c5a72..d34f9e5793 100644 --- a/internal/cli/api/api.go +++ b/internal/cli/api/api.go @@ -71,7 +71,7 @@ func Builder() *cobra.Command { func createRootAPICommand() *cobra.Command { rootCmd := &cobra.Command{ Use: "api", - Short: `Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '.`, + Short: `Access all features of the Atlas Administration API through the Atlas CLI by using the 'atlas api ' command.`, Long: `This feature streamlines script development by letting you interact directly with any Atlas Administration API endpoint by using the Atlas CLI. For more information on From f1bb6d876671801bd8aed9e4252ed6e396b17042 Mon Sep 17 00:00:00 2001 From: Luke Sanderson <94322623+Luke-Sanderson@users.noreply.github.com> Date: Mon, 6 Oct 2025 13:01:11 +0100 Subject: [PATCH 10/11] Docs comments Co-authored-by: kanchana-mongodb <54281287+kanchana-mongodb@users.noreply.github.com> --- internal/cli/api/api.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/cli/api/api.go b/internal/cli/api/api.go index d34f9e5793..ff60967030 100644 --- a/internal/cli/api/api.go +++ b/internal/cli/api/api.go @@ -72,7 +72,7 @@ func createRootAPICommand() *cobra.Command { rootCmd := &cobra.Command{ Use: "api", Short: `Access all features of the Atlas Administration API through the Atlas CLI by using the 'atlas api ' command.`, - Long: `This feature streamlines script development by letting you interact directly with any Atlas Administration API endpoint by using the Atlas CLI. + Long: `This feature streamlines script development by letting you interact directly with any Atlas Administration API endpoint through the Atlas CLI. For more information on - Atlas Administration API see: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/ From 5aaf9277eb6194fe3928984c3dafe72984e1d21a Mon Sep 17 00:00:00 2001 From: Luke Sanderson Date: Mon, 6 Oct 2025 13:08:40 +0100 Subject: [PATCH 11/11] run make gen-docs --- docs/command/atlas-api.txt | 4 ++-- docs/command/atlas.txt | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/command/atlas-api.txt b/docs/command/atlas-api.txt index 2d7e2f9267..4804f74c51 100644 --- a/docs/command/atlas-api.txt +++ b/docs/command/atlas-api.txt @@ -12,9 +12,9 @@ atlas api :depth: 1 :class: singlecol -Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '. +Access all features of the Atlas Administration API through the Atlas CLI by using the 'atlas api ' command. -This feature streamlines script development by letting you interact directly with any Atlas Administration API endpoint by using the Atlas CLI. +This feature streamlines script development by letting you interact directly with any Atlas Administration API endpoint through the Atlas CLI. For more information on - Atlas Administration API see: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/ diff --git a/docs/command/atlas.txt b/docs/command/atlas.txt index fa500acb46..480104d906 100644 --- a/docs/command/atlas.txt +++ b/docs/command/atlas.txt @@ -53,7 +53,7 @@ Related Commands * :ref:`atlas-accessLists` - Manage the list of IP addresses that can access your Atlas project. * :ref:`atlas-accessLogs` - Return the access logs for a cluster. * :ref:`atlas-alerts` - Manage alerts for your project. -* :ref:`atlas-api` - Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '. +* :ref:`atlas-api` - Access all features of the Atlas Administration API through the Atlas CLI by using the 'atlas api ' command. * :ref:`atlas-auditing` - Returns database auditing settings for MongoDB Cloud projects. * :ref:`atlas-auth` - Manage the CLI's authentication state. * :ref:`atlas-backups` - Manage cloud backups for your project.