From 068f142a49cab17546278b6815d0c168aa857139 Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Fri, 23 May 2025 10:51:32 +0200 Subject: [PATCH 1/4] CLOUDP-313028 --- ...ssTracking-listAccessLogsByClusterName.txt | 5 +- ...ccessTracking-listAccessLogsByHostname.txt | 5 +- docs/command/atlas-api-accessTracking.txt | 15 +- ...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 | 45 ++- .../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 | 25 +- ...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 | 95 +++++-- ...-api-auditing-getAuditingConfiguration.txt | 5 +- ...i-auditing-updateAuditingConfiguration.txt | 5 +- docs/command/atlas-api-auditing.txt | 15 +- ...las-api-awsClustersDns-getAwsCustomDns.txt | 5 +- ...-api-awsClustersDns-toggleAwsCustomDns.txt | 5 +- docs/command/atlas-api-awsClustersDns.txt | 15 +- ...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 | 155 ++++++++--- ...-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 | 45 ++- ...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 | 30 +- ...erOutageSimulation-endOutageSimulation.txt | 5 +- ...erOutageSimulation-getOutageSimulation.txt | 5 +- ...OutageSimulation-startOutageSimulation.txt | 5 +- .../atlas-api-clusterOutageSimulation.txt | 20 +- ...-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 | 100 +++++-- ...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 | 50 +++- ...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 | 30 +- ...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 | 75 ++++- ...s-api-dataLakePipelines-createPipeline.txt | 5 +- ...s-api-dataLakePipelines-deletePipeline.txt | 5 +- ...LakePipelines-deletePipelineRunDataset.txt | 5 +- ...tlas-api-dataLakePipelines-getPipeline.txt | 5 +- ...s-api-dataLakePipelines-getPipelineRun.txt | 5 +- ...api-dataLakePipelines-listPipelineRuns.txt | 5 +- ...ataLakePipelines-listPipelineSchedules.txt | 5 +- ...ataLakePipelines-listPipelineSnapshots.txt | 5 +- ...as-api-dataLakePipelines-listPipelines.txt | 5 +- ...as-api-dataLakePipelines-pausePipeline.txt | 5 +- ...s-api-dataLakePipelines-resumePipeline.txt | 5 +- ...LakePipelines-triggerSnapshotIngestion.txt | 5 +- ...s-api-dataLakePipelines-updatePipeline.txt | 5 +- docs/command/atlas-api-dataLakePipelines.txt | 70 ++++- ...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 | 30 +- ...-createEncryptionAtRestPrivateEndpoint.txt | 5 +- ...tomerKeyManagement-getEncryptionAtRest.txt | 5 +- ...ent-getEncryptionAtRestPrivateEndpoint.txt | 5 +- ...AtRestPrivateEndpointsForCloudProvider.txt | 5 +- ...ncryptionAtRestPrivateEndpointDeletion.txt | 5 +- ...erKeyManagement-updateEncryptionAtRest.txt | 5 +- ...yptionAtRestUsingCustomerKeyManagement.txt | 35 ++- .../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 | 30 +- ...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 | 95 +++++-- ...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 | 35 ++- ...RestoreJobs-createFlexBackupRestoreJob.txt | 5 +- ...lexRestoreJobs-getFlexBackupRestoreJob.txt | 5 +- ...xRestoreJobs-listFlexBackupRestoreJobs.txt | 5 +- docs/command/atlas-api-flexRestoreJobs.txt | 20 +- ...s-api-flexSnapshots-downloadFlexBackup.txt | 5 +- .../atlas-api-flexSnapshots-getFlexBackup.txt | 5 +- ...tlas-api-flexSnapshots-listFlexBackups.txt | 5 +- docs/command/atlas-api-flexSnapshots.txt | 20 +- ...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 | 30 +- ...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 | 40 ++- ...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 | 30 +- ...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 | 60 +++- ...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 | 30 +- ...-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 | 100 +++++-- ...-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 | 75 ++++- ...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 | 70 ++++- ...-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 | 35 ++- ...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 | 80 ++++-- ...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 | 60 +++- ...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 | 50 +++- ...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 | 75 ++++- ...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 | 30 +- .../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 | 120 ++++++-- ...Export-createPushBasedLogConfiguration.txt | 5 +- ...Export-deletePushBasedLogConfiguration.txt | 5 +- ...LogExport-getPushBasedLogConfiguration.txt | 5 +- ...Export-updatePushBasedLogConfiguration.txt | 5 +- docs/command/atlas-api-pushBasedLogExport.txt | 25 +- ...urcePolicies-createAtlasResourcePolicy.txt | 5 +- ...urcePolicies-deleteAtlasResourcePolicy.txt | 5 +- ...ourcePolicies-getAtlasResourcePolicies.txt | 5 +- ...esourcePolicies-getAtlasResourcePolicy.txt | 5 +- ...ourcePolicies-getResourcesNonCompliant.txt | 5 +- ...urcePolicies-updateAtlasResourcePolicy.txt | 5 +- ...cePolicies-validateAtlasResourcePolicy.txt | 5 +- docs/command/atlas-api-resourcePolicies.txt | 40 ++- ...as-api-rollingIndex-createRollingIndex.txt | 5 +- docs/command/atlas-api-rollingIndex.txt | 10 +- .../atlas-api-root-getSystemStatus.txt | 5 +- ...-root-returnAllControlPlaneIpAddresses.txt | 5 +- docs/command/atlas-api-root.txt | 15 +- ...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 | 30 +- ...points-createServerlessPrivateEndpoint.txt | 5 +- ...points-deleteServerlessPrivateEndpoint.txt | 5 +- ...Endpoints-getServerlessPrivateEndpoint.txt | 5 +- ...dpoints-listServerlessPrivateEndpoints.txt | 5 +- ...points-updateServerlessPrivateEndpoint.txt | 5 +- .../atlas-api-serverlessPrivateEndpoints.txt | 30 +- ...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 | 115 ++++++-- ...bs-createSharedClusterBackupRestoreJob.txt | 5 +- ...eJobs-getSharedClusterBackupRestoreJob.txt | 5 +- ...obs-listSharedClusterBackupRestoreJobs.txt | 5 +- .../atlas-api-sharedTierRestoreJobs.txt | 20 +- ...rSnapshots-downloadSharedClusterBackup.txt | 5 +- ...edTierSnapshots-getSharedClusterBackup.txt | 5 +- ...TierSnapshots-listSharedClusterBackups.txt | 5 +- .../command/atlas-api-sharedTierSnapshots.txt | 20 +- ...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 | 155 ++++++++--- .../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 +- 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 | 65 ++++- ...tegrations-createThirdPartyIntegration.txt | 5 +- ...tegrations-deleteThirdPartyIntegration.txt | 5 +- ...yIntegrations-getThirdPartyIntegration.txt | 5 +- ...ntegrations-listThirdPartyIntegrations.txt | 5 +- ...tegrations-updateThirdPartyIntegration.txt | 5 +- .../atlas-api-thirdPartyIntegrations.txt | 30 +- ...tication-createDatabaseUserCertificate.txt | 5 +- ...hentication-disableCustomerManagedX509.txt | 5 +- ...ntication-listDatabaseUserCertificates.txt | 5 +- docs/command/atlas-api-x509Authentication.txt | 20 +- docs/command/atlas-api.txt | 257 ++++++++++++++---- docs/command/atlas.txt | 2 +- internal/cli/api/api.go | 2 +- internal/cli/help_templates.go | 11 +- tools/cmd/docs/api_docs_long_text.txt | 6 +- tools/cmd/docs/transformations.go | 3 +- 508 files changed, 4036 insertions(+), 1015 deletions(-) diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt index 81024ee90d..c5ad59079a 100644 --- a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt +++ b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt @@ -12,7 +12,10 @@ atlas api accessTracking listAccessLogsByClusterName :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the access logs of one cluster identified by the cluster's name. +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. + +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 1e90496484..f38a25d82a 100644 --- a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt +++ b/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt @@ -12,7 +12,10 @@ atlas api accessTracking listAccessLogsByHostname :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the access logs of one cluster identified by the cluster's hostname. +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. + +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 6f605408a5..d9e4e8f095 100644 --- a/docs/command/atlas-api-accessTracking.txt +++ b/docs/command/atlas-api-accessTracking.txt @@ -12,7 +12,10 @@ atlas api accessTracking :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns access logs for authentication attempts made to Atlas database deployments. +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. + +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. @@ -51,8 +54,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - `Public Preview: please provide feedback at `_: Returns the access logs of one cluster identified by the cluster's name. -* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - `Public Preview: please provide feedback at `_: Returns the access logs of one cluster identified by the cluster's hostname. +* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - 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. + +Returns the access logs of one cluster identified by the cluster's name. +* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - 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. + +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 88ed19505e..e29707c781 100644 --- a/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt @@ -12,7 +12,10 @@ atlas api alertConfigurations createAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one alert configuration for the specified project. +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. + +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 332e2955c5..938647c3e8 100644 --- a/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt @@ -12,7 +12,10 @@ atlas api alertConfigurations deleteAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one alert configuration from the specified project. +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. + +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 ce5faf039d..f461cbc39d 100644 --- a/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt @@ -12,7 +12,10 @@ atlas api alertConfigurations getAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the specified alert configuration from the specified project. +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. + +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 3ca531c7ee..f231ba6066 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt @@ -12,7 +12,10 @@ atlas api alertConfigurations listAlertConfigurationMatchersFieldNames :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. +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. + +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 2db1a88f15..f2f9aeaf86 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt @@ -12,7 +12,10 @@ atlas api alertConfigurations listAlertConfigurations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all alert configurations for one project. +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. + +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 42d76f0e51..59d54efd5d 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt @@ -12,7 +12,10 @@ atlas api alertConfigurations listAlertConfigurationsByAlertId :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all alert configurations set for the specified alert. +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. + +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 66a1d6e807..c7d140f5bc 100644 --- a/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt @@ -12,7 +12,10 @@ atlas api alertConfigurations toggleAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Enables or disables the specified alert configuration in the specified project. +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. + +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 bdc629b2b9..211b152380 100644 --- a/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt @@ -12,7 +12,10 @@ atlas api alertConfigurations updateAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one alert configuration in the specified project. +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. + +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 b05caf3c2e..f2b0e8a54b 100644 --- a/docs/command/atlas-api-alertConfigurations.txt +++ b/docs/command/atlas-api-alertConfigurations.txt @@ -12,7 +12,10 @@ atlas api alertConfigurations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. +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. + +Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change. @@ -51,14 +54,38 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - `Public Preview: please provide feedback at `_: Creates one alert configuration for the specified project. -* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - `Public Preview: please provide feedback at `_: Removes one alert configuration from the specified project. -* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - `Public Preview: please provide feedback at `_: Returns the specified alert configuration from the specified project. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - `Public Preview: please provide feedback at `_: 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 at `_: Returns all alert configurations for one project. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - `Public Preview: please provide feedback at `_: Returns all alert configurations set for the specified alert. -* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - `Public Preview: please provide feedback at `_: Enables or disables the specified alert configuration in the specified project. -* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - `Public Preview: please provide feedback at `_: Updates one alert configuration in the specified project. +* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - 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. + +Creates one alert configuration for the specified project. +* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - 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. + +Removes one alert configuration from the specified project. +* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - 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. + +Returns the specified alert configuration from the specified project. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - 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. + +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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - 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. + +Returns all alert configurations set for the specified alert. +* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - 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. + +Enables or disables the specified alert configuration in the specified project. +* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - 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. + +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 3cc8bde25a..8945c29752 100644 --- a/docs/command/atlas-api-alerts-acknowledgeAlert.txt +++ b/docs/command/atlas-api-alerts-acknowledgeAlert.txt @@ -12,7 +12,10 @@ atlas api alerts acknowledgeAlert :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Confirms receipt of one existing alert. +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. + +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 5ec5d9ca0b..24c0cac4fa 100644 --- a/docs/command/atlas-api-alerts-getAlert.txt +++ b/docs/command/atlas-api-alerts-getAlert.txt @@ -12,7 +12,10 @@ atlas api alerts getAlert :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one alert. +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. + +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 2bd4492ee2..e34de2622d 100644 --- a/docs/command/atlas-api-alerts-listAlerts.txt +++ b/docs/command/atlas-api-alerts-listAlerts.txt @@ -12,7 +12,10 @@ atlas api alerts listAlerts :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all alerts. +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. + +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 01a4bc1664..c260e2576c 100644 --- a/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt +++ b/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt @@ -12,7 +12,10 @@ atlas api alerts listAlertsByAlertConfigurationId :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all open alerts that the specified alert configuration triggers. +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. + +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 717f4073a7..942d101b9a 100644 --- a/docs/command/atlas-api-alerts.txt +++ b/docs/command/atlas-api-alerts.txt @@ -12,7 +12,10 @@ atlas api alerts :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. +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. + +Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change. @@ -51,10 +54,22 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alerts-acknowledgeAlert` - `Public Preview: please provide feedback at `_: Confirms receipt of one existing alert. -* :ref:`atlas-api-alerts-getAlert` - `Public Preview: please provide feedback at `_: Returns one alert. -* :ref:`atlas-api-alerts-listAlerts` - `Public Preview: please provide feedback at `_: Returns all alerts. -* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - `Public Preview: please provide feedback at `_: Returns all open alerts that the specified alert configuration triggers. +* :ref:`atlas-api-alerts-acknowledgeAlert` - 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. + +Confirms receipt of one existing alert. +* :ref:`atlas-api-alerts-getAlert` - 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. + +Returns one alert. +* :ref:`atlas-api-alerts-listAlerts` - 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. + +Returns all alerts. +* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - 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. + +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 14e3eea21d..21da8fe6c1 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt @@ -12,7 +12,10 @@ atlas api atlasSearch createAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates Search Nodes for the specified cluster. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchDeployment. diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt index 0712474794..e7ff5ca048 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt @@ -12,7 +12,10 @@ atlas api atlasSearch createAtlasSearchIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one Atlas Search index on the specified collection. +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. + +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 f42711c138..f444c6318b 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt @@ -12,7 +12,10 @@ atlas api atlasSearch createAtlasSearchIndexDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one Atlas Search index on the specified collection. +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. + +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 bbc595e622..5417e75b6f 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt @@ -12,7 +12,10 @@ atlas api atlasSearch deleteAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes the Search Nodes for the specified cluster. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchDeployment. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt index da7ead331a..6a92b9b2cb 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt @@ -12,7 +12,10 @@ atlas api atlasSearch deleteAtlasSearchIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its unique ID. +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. + +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 f958869631..624a4b6130 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt @@ -12,7 +12,10 @@ atlas api atlasSearch deleteAtlasSearchIndexByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its database, collection, and name. +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. + +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 127c964826..27eabafea0 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt @@ -12,7 +12,10 @@ atlas api atlasSearch deleteAtlasSearchIndexDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its unique ID. +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. + +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 b8b5127c20..450411ce07 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt @@ -12,7 +12,10 @@ atlas api atlasSearch getAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the Search Nodes for the specified cluster. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchDeployment. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt index a8319a44ac..10cf602f8b 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt @@ -12,7 +12,10 @@ atlas api atlasSearch getAtlasSearchIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one Atlas Search index that you identified with its unique ID. +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. + +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 cf08903de4..b68e230afc 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt @@ -12,7 +12,10 @@ atlas api atlasSearch getAtlasSearchIndexByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one Atlas Search index that you identified with its database, collection name, and index name. +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. + +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 6259bb2e23..afee4a44f1 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt @@ -12,7 +12,10 @@ atlas api atlasSearch getAtlasSearchIndexDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one Atlas Search index in the specified project. +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. + +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 ea78c09365..0ae56d0119 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt @@ -12,7 +12,10 @@ atlas api atlasSearch listAtlasSearchIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified collection. +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. + +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 c61864b720..b37b310272 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt @@ -12,7 +12,10 @@ atlas api atlasSearch listAtlasSearchIndexesCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified cluster. +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. + +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 00ec8117dc..50df8a267c 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt @@ -12,7 +12,10 @@ atlas api atlasSearch listAtlasSearchIndexesDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified collection. +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. + +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 09ba5a3a49..2939a94cf3 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt @@ -12,7 +12,10 @@ atlas api atlasSearch updateAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the Search Nodes for the specified cluster. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchDeployment. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt index ef0cb86e03..478ed9b966 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt @@ -12,7 +12,10 @@ atlas api atlasSearch updateAtlasSearchIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one Atlas Search index that you identified with its unique ID. +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. + +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 b2b1555b7f..a4722443c2 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt @@ -12,7 +12,10 @@ atlas api atlasSearch updateAtlasSearchIndexByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one Atlas Search index that you identified with its database, collection name, and index name. +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. + +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 2990f223ed..65502ac0e4 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt @@ -12,7 +12,10 @@ atlas api atlasSearch updateAtlasSearchIndexDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one Atlas Search index that you identified with its unique ID. +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. + +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 c550c6ad9c..063cbd17bb 100644 --- a/docs/command/atlas-api-atlasSearch.txt +++ b/docs/command/atlas-api-atlasSearch.txt @@ -12,7 +12,10 @@ atlas api atlasSearch :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. +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. + +Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. Also returns and updates user-defined analyzers for the specified cluster. @@ -51,24 +54,78 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-atlasSearch-createAtlasSearchDeployment` - `Public Preview: please provide feedback at `_: Creates Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-createAtlasSearchIndex` - `Public Preview: please provide feedback at `_: Creates one Atlas Search index on the specified collection. -* :ref:`atlas-api-atlasSearch-createAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback at `_: Creates one Atlas Search index on the specified collection. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchDeployment` - `Public Preview: please provide feedback at `_: Deletes the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndex` - `Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexByName` - `Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its database, collection, and name. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated` - `Public Preview: please provide feedback at `_: Removes one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-getAtlasSearchDeployment` - `Public Preview: please provide feedback at `_: Returns the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndex` - `Public Preview: please provide feedback at `_: Returns one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexByName` - `Public Preview: please provide feedback at `_: 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 at `_: Returns one Atlas Search index in the specified project. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexes` - `Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified collection. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesCluster` - `Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified cluster. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated` - `Public Preview: please provide feedback at `_: Returns all Atlas Search indexes on the specified collection. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchDeployment` - `Public Preview: please provide feedback at `_: Updates the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndex` - `Public Preview: please provide feedback at `_: Updates one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexByName` - `Public Preview: please provide feedback at `_: 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 at `_: Updates one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-createAtlasSearchDeployment` - 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. + +Creates Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-createAtlasSearchIndex` - 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. + +Creates one Atlas Search index on the specified collection. +* :ref:`atlas-api-atlasSearch-createAtlasSearchIndexDeprecated` - 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. + +Creates one Atlas Search index on the specified collection. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchDeployment` - 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. + +Deletes the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndex` - 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. + +Removes one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexByName` - 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. + +Removes one Atlas Search index that you identified with its database, collection, and name. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated` - 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. + +Removes one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-getAtlasSearchDeployment` - 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. + +Returns the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndex` - 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. + +Returns one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexByName` - 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. + +Returns one Atlas Search index that you identified with its database, collection name, and index name. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexDeprecated` - 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. + +Returns one Atlas Search index in the specified project. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexes` - 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. + +Returns all Atlas Search indexes on the specified collection. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesCluster` - 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. + +Returns all Atlas Search indexes on the specified cluster. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated` - 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. + +Returns all Atlas Search indexes on the specified collection. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchDeployment` - 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. + +Updates the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndex` - 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. + +Updates one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexByName` - 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. + +Updates one Atlas Search index that you identified with its database, collection name, and index name. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated` - 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. + +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 b6f8820919..c71964c4d9 100644 --- a/docs/command/atlas-api-auditing-getAuditingConfiguration.txt +++ b/docs/command/atlas-api-auditing-getAuditingConfiguration.txt @@ -12,7 +12,10 @@ atlas api auditing getAuditingConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the auditing configuration for the specified project. +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. + +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 d288654942..af022d2b14 100644 --- a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt +++ b/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt @@ -12,7 +12,10 @@ atlas api auditing updateAuditingConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the auditing configuration for the specified project. +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. + +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 b8f6b066a2..f192e3c5ac 100644 --- a/docs/command/atlas-api-auditing.txt +++ b/docs/command/atlas-api-auditing.txt @@ -12,7 +12,10 @@ atlas api auditing :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and edits database auditing settings for MongoDB Cloud projects. +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. + +Returns and edits database auditing settings for MongoDB Cloud projects. Options ------- @@ -49,8 +52,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-auditing-getAuditingConfiguration` - `Public Preview: please provide feedback at `_: Returns the auditing configuration for the specified project. -* :ref:`atlas-api-auditing-updateAuditingConfiguration` - `Public Preview: please provide feedback at `_: Updates the auditing configuration for the specified project. +* :ref:`atlas-api-auditing-getAuditingConfiguration` - 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. + +Returns the auditing configuration for the specified project. +* :ref:`atlas-api-auditing-updateAuditingConfiguration` - 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. + +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 3cd6bdd1d4..7039431332 100644 --- a/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt +++ b/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt @@ -12,7 +12,10 @@ atlas api awsClustersDns getAwsCustomDns :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the custom DNS configuration for AWS clusters in the specified project. +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. + +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 b898f6fa9b..830a7314c9 100644 --- a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt +++ b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt @@ -12,7 +12,10 @@ atlas api awsClustersDns toggleAwsCustomDns :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Enables or disables the custom DNS configuration for AWS clusters in the specified project. +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. + +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 3542354c06..48d1c54a57 100644 --- a/docs/command/atlas-api-awsClustersDns.txt +++ b/docs/command/atlas-api-awsClustersDns.txt @@ -12,7 +12,10 @@ atlas api awsClustersDns :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. +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. + +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. @@ -51,8 +54,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-awsClustersDns-getAwsCustomDns` - `Public Preview: please provide feedback at `_: Returns the custom DNS configuration for AWS clusters in the specified project. -* :ref:`atlas-api-awsClustersDns-toggleAwsCustomDns` - `Public Preview: please provide feedback at `_: Enables or disables the custom DNS configuration for AWS clusters in the specified project. +* :ref:`atlas-api-awsClustersDns-getAwsCustomDns` - 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. + +Returns the custom DNS configuration for AWS clusters in the specified project. +* :ref:`atlas-api-awsClustersDns-toggleAwsCustomDns` - 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. + +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 1fff972e20..ccbe52983e 100644 --- a/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt @@ -12,7 +12,10 @@ atlas api cloudBackups cancelBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Cancels one cloud backup restore job of one cluster from the specified project. +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. + +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 5d8c3c5d97..c45aced3ee 100644 --- a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt +++ b/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt @@ -12,7 +12,10 @@ atlas api cloudBackups createBackupExportJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. +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. + +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 8a173c813e..757141a453 100644 --- a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt @@ -12,7 +12,10 @@ atlas api cloudBackups createBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Restores one snapshot of one cluster from the specified project. +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. + +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 3091b09356..043701fbaf 100644 --- a/docs/command/atlas-api-cloudBackups-createExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-createExportBucket.txt @@ -12,7 +12,10 @@ atlas api cloudBackups createExportBucket :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. +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. + +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 2b6bd50040..b886d48497 100644 --- a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt @@ -12,7 +12,10 @@ atlas api cloudBackups createServerlessBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Restores one snapshot of one serverless instance from the specified project. +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. + +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 07d353d504..a4514c7dc2 100644 --- a/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt +++ b/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt @@ -12,7 +12,10 @@ atlas api cloudBackups deleteAllBackupSchedules :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes all cloud backup schedules for the specified cluster. +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. + +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 9bedcb8458..90dfaa78f7 100644 --- a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt @@ -12,7 +12,10 @@ atlas api cloudBackups deleteExportBucket :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes an Export Bucket. +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. + +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 86edc13776..d01443d65b 100644 --- a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt +++ b/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt @@ -12,7 +12,10 @@ atlas api cloudBackups deleteReplicaSetBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified snapshot. +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. + +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 ca09c87631..261284792c 100644 --- a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt +++ b/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt @@ -12,7 +12,10 @@ atlas api cloudBackups deleteShardedClusterBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one snapshot of one sharded cluster from the specified project. +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. + +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 a9ac3b55ef..67117d5d21 100644 --- a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt @@ -12,7 +12,10 @@ atlas api cloudBackups disableDataProtectionSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Disables the Backup Compliance Policy settings with the specified project. +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. + +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 5051db29ad..edc17f8e53 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt @@ -12,7 +12,10 @@ atlas api cloudBackups getBackupExportJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. +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. + +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 6f9c096eec..285f01c209 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt @@ -12,7 +12,10 @@ atlas api cloudBackups getBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one cloud backup restore job for one cluster from the specified project. +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. + +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 1b82900a34..0ab40faf69 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt @@ -12,7 +12,10 @@ atlas api cloudBackups getBackupSchedule :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the cloud backup schedule for the specified cluster within the specified project. +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. + +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 7092059d16..d9a89c5096 100644 --- a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt @@ -12,7 +12,10 @@ atlas api cloudBackups getDataProtectionSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the Backup Compliance Policy settings with the specified project. +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. + +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 60ac210376..9623c68d99 100644 --- a/docs/command/atlas-api-cloudBackups-getExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-getExportBucket.txt @@ -12,7 +12,10 @@ atlas api cloudBackups getExportBucket :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one Export Bucket associated with the specified Project. +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. + +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 d9f9848af0..7f6ba8400f 100644 --- a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt @@ -12,7 +12,10 @@ atlas api cloudBackups getReplicaSetBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one snapshot from the specified cluster. +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. + +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 861ae06916..3480180bdf 100644 --- a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt @@ -12,7 +12,10 @@ atlas api cloudBackups getServerlessBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one snapshot of one serverless instance from the specified project. +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. + +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 156cc777ac..e72674f5b1 100644 --- a/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt @@ -12,7 +12,10 @@ atlas api cloudBackups getServerlessBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one restore job for one serverless instance from the specified project. +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. + +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 75f081acc7..b16f8979a5 100644 --- a/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt @@ -12,7 +12,10 @@ atlas api cloudBackups getShardedClusterBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one snapshot of one sharded cluster from the specified project. +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. + +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 03f02fc153..1f58672ca1 100644 --- a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt @@ -12,7 +12,10 @@ atlas api cloudBackups listBackupExportJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. +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. + +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 a8f8f7b84d..a70bed5d90 100644 --- a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt @@ -12,7 +12,10 @@ atlas api cloudBackups listBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all cloud backup restore jobs for one cluster from the specified project. +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. + +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 c9b19d88b2..fb533a2845 100644 --- a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt +++ b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt @@ -12,7 +12,10 @@ atlas api cloudBackups listExportBuckets :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Export Buckets associated with the specified Project. +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. + +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 df5371f1cf..f4d5267e79 100644 --- a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt @@ -12,7 +12,10 @@ atlas api cloudBackups listReplicaSetBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all snapshots of one cluster from the specified project. +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. + +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 234f418be8..a191443fd0 100644 --- a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt @@ -12,7 +12,10 @@ atlas api cloudBackups listServerlessBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all restore jobs for one serverless instance from the specified project. +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. + +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 f080bfcbd6..9985f66017 100644 --- a/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt @@ -12,7 +12,10 @@ atlas api cloudBackups listServerlessBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all snapshots of one serverless instance from the specified project. +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. + +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 2b7a265142..98b6baeb25 100644 --- a/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt @@ -12,7 +12,10 @@ atlas api cloudBackups listShardedClusterBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all snapshots of one sharded cluster from the specified project. +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. + +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 30774ad320..bb59aaebe5 100644 --- a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt +++ b/docs/command/atlas-api-cloudBackups-takeSnapshot.txt @@ -12,7 +12,10 @@ atlas api cloudBackups takeSnapshot :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Takes one on-demand snapshot for the specified cluster. +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. + +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 c54ca0836e..ef29552fe4 100644 --- a/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt +++ b/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt @@ -12,7 +12,10 @@ atlas api cloudBackups updateBackupSchedule :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the cloud backup schedule for one cluster within the specified project. +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. + +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 8b5ba1695d..ead854f513 100644 --- a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt @@ -12,7 +12,10 @@ atlas api cloudBackups updateDataProtectionSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the Backup Compliance Policy settings for the specified project. +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. + +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 5e29072d06..fd215c15b1 100644 --- a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt +++ b/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt @@ -12,7 +12,10 @@ atlas api cloudBackups updateSnapshotRetention :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +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. + +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 96e7207e66..372027a72c 100644 --- a/docs/command/atlas-api-cloudBackups.txt +++ b/docs/command/atlas-api-cloudBackups.txt @@ -12,7 +12,10 @@ atlas api cloudBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. +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. + +Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups. @@ -51,36 +54,126 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudBackups-cancelBackupRestoreJob` - `Public Preview: please provide feedback at `_: Cancels one cloud backup restore job of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-createBackupExportJob` - `Public Preview: please provide feedback at `_: 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 at `_: Restores one snapshot of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-createExportBucket` - `Public Preview: please provide feedback at `_: 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 at `_: Restores one snapshot of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-deleteAllBackupSchedules` - `Public Preview: please provide feedback at `_: Removes all cloud backup schedules for the specified cluster. -* :ref:`atlas-api-cloudBackups-deleteExportBucket` - `Public Preview: please provide feedback at `_: Deletes an Export Bucket. -* :ref:`atlas-api-cloudBackups-deleteReplicaSetBackup` - `Public Preview: please provide feedback at `_: Removes the specified snapshot. -* :ref:`atlas-api-cloudBackups-deleteShardedClusterBackup` - `Public Preview: please provide feedback at `_: Removes one snapshot of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-disableDataProtectionSettings` - `Public Preview: please provide feedback at `_: Disables the Backup Compliance Policy settings with the specified project. -* :ref:`atlas-api-cloudBackups-getBackupExportJob` - `Public Preview: please provide feedback at `_: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. -* :ref:`atlas-api-cloudBackups-getBackupRestoreJob` - `Public Preview: please provide feedback at `_: Returns one cloud backup restore job for one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-getBackupSchedule` - `Public Preview: please provide feedback at `_: Returns the cloud backup schedule for the specified cluster within the specified project. -* :ref:`atlas-api-cloudBackups-getDataProtectionSettings` - `Public Preview: please provide feedback at `_: Returns the Backup Compliance Policy settings with the specified project. -* :ref:`atlas-api-cloudBackups-getExportBucket` - `Public Preview: please provide feedback at `_: Returns one Export Bucket associated with the specified Project. -* :ref:`atlas-api-cloudBackups-getReplicaSetBackup` - `Public Preview: please provide feedback at `_: Returns one snapshot from the specified cluster. -* :ref:`atlas-api-cloudBackups-getServerlessBackup` - `Public Preview: please provide feedback at `_: Returns one snapshot of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-getServerlessBackupRestoreJob` - `Public Preview: please provide feedback at `_: Returns one restore job for one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-getShardedClusterBackup` - `Public Preview: please provide feedback at `_: Returns one snapshot of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listBackupExportJobs` - `Public Preview: please provide feedback at `_: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. -* :ref:`atlas-api-cloudBackups-listBackupRestoreJobs` - `Public Preview: please provide feedback at `_: Returns all cloud backup restore jobs for one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listExportBuckets` - `Public Preview: please provide feedback at `_: Returns all Export Buckets associated with the specified Project. -* :ref:`atlas-api-cloudBackups-listReplicaSetBackups` - `Public Preview: please provide feedback at `_: Returns all snapshots of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listServerlessBackupRestoreJobs` - `Public Preview: please provide feedback at `_: Returns all restore jobs for one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-listServerlessBackups` - `Public Preview: please provide feedback at `_: Returns all snapshots of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-listShardedClusterBackups` - `Public Preview: please provide feedback at `_: Returns all snapshots of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-takeSnapshot` - `Public Preview: please provide feedback at `_: Takes one on-demand snapshot for the specified cluster. -* :ref:`atlas-api-cloudBackups-updateBackupSchedule` - `Public Preview: please provide feedback at `_: Updates the cloud backup schedule for one cluster within the specified project. -* :ref:`atlas-api-cloudBackups-updateDataProtectionSettings` - `Public Preview: please provide feedback at `_: Updates the Backup Compliance Policy settings for the specified project. -* :ref:`atlas-api-cloudBackups-updateSnapshotRetention` - `Public Preview: please provide feedback at `_: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-cloudBackups-cancelBackupRestoreJob` - 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. + +Cancels one cloud backup restore job of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-createBackupExportJob` - 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. + +Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. +* :ref:`atlas-api-cloudBackups-createBackupRestoreJob` - 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. + +Restores one snapshot of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-createExportBucket` - 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. + +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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +* :ref:`atlas-api-cloudBackups-deleteAllBackupSchedules` - 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. + +Removes all cloud backup schedules for the specified cluster. +* :ref:`atlas-api-cloudBackups-deleteExportBucket` - 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. + +Deletes an Export Bucket. +* :ref:`atlas-api-cloudBackups-deleteReplicaSetBackup` - 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. + +Removes the specified snapshot. +* :ref:`atlas-api-cloudBackups-deleteShardedClusterBackup` - 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. + +Removes one snapshot of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-disableDataProtectionSettings` - 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. + +Disables the Backup Compliance Policy settings with the specified project. +* :ref:`atlas-api-cloudBackups-getBackupExportJob` - 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. + +Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. +* :ref:`atlas-api-cloudBackups-getBackupRestoreJob` - 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. + +Returns one cloud backup restore job for one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-getBackupSchedule` - 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. + +Returns the cloud backup schedule for the specified cluster within the specified project. +* :ref:`atlas-api-cloudBackups-getDataProtectionSettings` - 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. + +Returns the Backup Compliance Policy settings with the specified project. +* :ref:`atlas-api-cloudBackups-getExportBucket` - 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. + +Returns one Export Bucket associated with the specified Project. +* :ref:`atlas-api-cloudBackups-getReplicaSetBackup` - 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. + +Returns one snapshot from the specified cluster. +* :ref:`atlas-api-cloudBackups-getServerlessBackup` - 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. + +Returns one snapshot of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-getServerlessBackupRestoreJob` - 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. + +Returns one restore job for one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-getShardedClusterBackup` - 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. + +Returns one snapshot of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listBackupExportJobs` - 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. + +Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. +* :ref:`atlas-api-cloudBackups-listBackupRestoreJobs` - 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. + +Returns all cloud backup restore jobs for one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listExportBuckets` - 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. + +Returns all Export Buckets associated with the specified Project. +* :ref:`atlas-api-cloudBackups-listReplicaSetBackups` - 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. + +Returns all snapshots of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listServerlessBackupRestoreJobs` - 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. + +Returns all restore jobs for one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-listServerlessBackups` - 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. + +Returns all snapshots of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-listShardedClusterBackups` - 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. + +Returns all snapshots of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-takeSnapshot` - 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. + +Takes one on-demand snapshot for the specified cluster. +* :ref:`atlas-api-cloudBackups-updateBackupSchedule` - 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. + +Updates the cloud backup schedule for one cluster within the specified project. +* :ref:`atlas-api-cloudBackups-updateDataProtectionSettings` - 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. + +Updates the Backup Compliance Policy settings for the specified project. +* :ref:`atlas-api-cloudBackups-updateSnapshotRetention` - 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. + +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 90a7c18256..c4e9e70e8b 100644 --- a/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt +++ b/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt @@ -12,7 +12,10 @@ atlas api cloudMigrationService createLinkToken :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Create one link-token that contains all the information required to complete the link. +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. + +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 1d2da53ea2..1679333715 100644 --- a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt @@ -12,7 +12,10 @@ atlas api cloudMigrationService createPushMigration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. +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. + +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 ed234c0da3..f13e7c2b92 100644 --- a/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt @@ -12,7 +12,10 @@ atlas api cloudMigrationService cutoverMigration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Cut over the migrated cluster to MongoDB Atlas. +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. + +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 7ae7d4a934..ba633fcc51 100644 --- a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt +++ b/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt @@ -12,7 +12,10 @@ atlas api cloudMigrationService deleteLinkToken :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Remove one organization link and its associated public API key. +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. + +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 a604f6c929..6286638eb5 100644 --- a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt @@ -12,7 +12,10 @@ atlas api cloudMigrationService getPushMigration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return details of one cluster migration job. +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. + +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 976cbbc480..2825a92d3b 100644 --- a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt +++ b/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt @@ -12,7 +12,10 @@ atlas api cloudMigrationService getValidationStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return the status of one migration validation job. +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. + +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 163b02eea0..fe90434b6d 100644 --- a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt +++ b/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt @@ -12,7 +12,10 @@ atlas api cloudMigrationService listSourceProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return all projects that you can migrate to the specified organization. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/listSourceProjects. diff --git a/docs/command/atlas-api-cloudMigrationService-validateMigration.txt b/docs/command/atlas-api-cloudMigrationService-validateMigration.txt index a142e65cbd..ea8897e3e3 100644 --- a/docs/command/atlas-api-cloudMigrationService-validateMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-validateMigration.txt @@ -12,7 +12,10 @@ atlas api cloudMigrationService validateMigration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. +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. + +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 b914deb87e..66859a470a 100644 --- a/docs/command/atlas-api-cloudMigrationService.txt +++ b/docs/command/atlas-api-cloudMigrationService.txt @@ -12,7 +12,10 @@ atlas api cloudMigrationService :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Manages the Cloud Migration Service. +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. + +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. @@ -51,14 +54,38 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudMigrationService-createLinkToken` - `Public Preview: please provide feedback at `_: Create one link-token that contains all the information required to complete the link. -* :ref:`atlas-api-cloudMigrationService-createPushMigration` - `Public Preview: please provide feedback at `_: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. -* :ref:`atlas-api-cloudMigrationService-cutoverMigration` - `Public Preview: please provide feedback at `_: Cut over the migrated cluster to MongoDB Atlas. -* :ref:`atlas-api-cloudMigrationService-deleteLinkToken` - `Public Preview: please provide feedback at `_: Remove one organization link and its associated public API key. -* :ref:`atlas-api-cloudMigrationService-getPushMigration` - `Public Preview: please provide feedback at `_: Return details of one cluster migration job. -* :ref:`atlas-api-cloudMigrationService-getValidationStatus` - `Public Preview: please provide feedback at `_: Return the status of one migration validation job. -* :ref:`atlas-api-cloudMigrationService-listSourceProjects` - `Public Preview: please provide feedback at `_: Return all projects that you can migrate to the specified organization. -* :ref:`atlas-api-cloudMigrationService-validateMigration` - `Public Preview: please provide feedback at `_: 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` - 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. + +Create one link-token that contains all the information required to complete the link. +* :ref:`atlas-api-cloudMigrationService-createPushMigration` - 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. + +Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. +* :ref:`atlas-api-cloudMigrationService-cutoverMigration` - 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. + +Cut over the migrated cluster to MongoDB Atlas. +* :ref:`atlas-api-cloudMigrationService-deleteLinkToken` - 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. + +Remove one organization link and its associated public API key. +* :ref:`atlas-api-cloudMigrationService-getPushMigration` - 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. + +Return details of one cluster migration job. +* :ref:`atlas-api-cloudMigrationService-getValidationStatus` - 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. + +Return the status of one migration validation job. +* :ref:`atlas-api-cloudMigrationService-listSourceProjects` - 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. + +Return all projects that you can migrate to the specified organization. +* :ref:`atlas-api-cloudMigrationService-validateMigration` - 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. + +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 37f8e67456..7be61ef6bf 100644 --- a/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt @@ -12,7 +12,10 @@ atlas api cloudProviderAccess authorizeCloudProviderAccessRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Grants access to the specified project for the specified access role. +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. + +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 ec3e9d3ee1..6d4160ace9 100644 --- a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt @@ -12,7 +12,10 @@ atlas api cloudProviderAccess createCloudProviderAccessRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one access role for the specified cloud provider. +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. + +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. diff --git a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt index 1b04845853..1938478ed3 100644 --- a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt @@ -12,7 +12,10 @@ atlas api cloudProviderAccess deauthorizeCloudProviderAccessRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Revokes access to the specified project for the specified access role. +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. + +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 f7aa778add..940284544b 100644 --- a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt @@ -12,7 +12,10 @@ atlas api cloudProviderAccess getCloudProviderAccessRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the access role with the specified id and with access to the specified project. +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. + +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 0056553c3e..234d675184 100644 --- a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt +++ b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt @@ -12,7 +12,10 @@ atlas api cloudProviderAccess listCloudProviderAccessRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all cloud provider access roles with access to the specified project. +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. + +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 36a7aa919d..843eeffb81 100644 --- a/docs/command/atlas-api-cloudProviderAccess.txt +++ b/docs/command/atlas-api-cloudProviderAccess.txt @@ -12,7 +12,10 @@ atlas api cloudProviderAccess :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. +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. + +Returns, adds, authorizes, and removes AWS IAM roles in Atlas. Options ------- @@ -49,11 +52,26 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole` - `Public Preview: please provide feedback at `_: Grants access to the specified project for the specified access role. -* :ref:`atlas-api-cloudProviderAccess-createCloudProviderAccessRole` - `Public Preview: please provide feedback at `_: Creates one access role for the specified cloud provider. -* :ref:`atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole` - `Public Preview: please provide feedback at `_: Revokes access to the specified project for the specified access role. -* :ref:`atlas-api-cloudProviderAccess-getCloudProviderAccessRole` - `Public Preview: please provide feedback at `_: 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 at `_: Returns all cloud provider access roles with access to the specified project. +* :ref:`atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole` - 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. + +Grants access to the specified project for the specified access role. +* :ref:`atlas-api-cloudProviderAccess-createCloudProviderAccessRole` - 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. + +Creates one access role for the specified cloud provider. +* :ref:`atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole` - 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. + +Revokes access to the specified project for the specified access role. +* :ref:`atlas-api-cloudProviderAccess-getCloudProviderAccessRole` - 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. + +Returns the access role with the specified id and with access to the specified project. +* :ref:`atlas-api-cloudProviderAccess-listCloudProviderAccessRoles` - 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. + +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 a7aeefcf15..1d6439046c 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt @@ -12,7 +12,10 @@ atlas api clusterOutageSimulation endOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Ends a cluster outage simulation. +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. + +Ends a cluster outage simulation. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/endOutageSimulation. diff --git a/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt index f6ce8a96bc..a1a2486886 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt @@ -12,7 +12,10 @@ atlas api clusterOutageSimulation getOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one outage simulation for one cluster. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/getOutageSimulation. diff --git a/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt index f2d4076f6a..5749749449 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt @@ -12,7 +12,10 @@ atlas api clusterOutageSimulation startOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Starts a cluster outage simulation. +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. + +Starts a cluster outage simulation. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/startOutageSimulation. diff --git a/docs/command/atlas-api-clusterOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation.txt index 2e11513cd9..a905e184b4 100644 --- a/docs/command/atlas-api-clusterOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation.txt @@ -12,7 +12,10 @@ atlas api clusterOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, starts, or ends a cluster outage simulation. +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. + +Returns, starts, or ends a cluster outage simulation. Options ------- @@ -49,9 +52,18 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-clusterOutageSimulation-endOutageSimulation` - `Public Preview: please provide feedback at `_: Ends a cluster outage simulation. -* :ref:`atlas-api-clusterOutageSimulation-getOutageSimulation` - `Public Preview: please provide feedback at `_: Returns one outage simulation for one cluster. -* :ref:`atlas-api-clusterOutageSimulation-startOutageSimulation` - `Public Preview: please provide feedback at `_: Starts a cluster outage simulation. +* :ref:`atlas-api-clusterOutageSimulation-endOutageSimulation` - 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. + +Ends a cluster outage simulation. +* :ref:`atlas-api-clusterOutageSimulation-getOutageSimulation` - 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. + +Returns one outage simulation for one cluster. +* :ref:`atlas-api-clusterOutageSimulation-startOutageSimulation` - 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. + +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 238bbf332c..865baaf4c0 100644 --- a/docs/command/atlas-api-clusters-autoScalingConfiguration.txt +++ b/docs/command/atlas-api-clusters-autoScalingConfiguration.txt @@ -12,7 +12,10 @@ atlas api clusters autoScalingConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the internal configuration of AutoScaling for sharded clusters. +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. + +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 5ed626198c..c025b4784f 100644 --- a/docs/command/atlas-api-clusters-createCluster.txt +++ b/docs/command/atlas-api-clusters-createCluster.txt @@ -12,7 +12,10 @@ atlas api clusters createCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one cluster in the specified project. +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. + +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 86afd5ecd0..8ee83b29e0 100644 --- a/docs/command/atlas-api-clusters-deleteCluster.txt +++ b/docs/command/atlas-api-clusters-deleteCluster.txt @@ -12,7 +12,10 @@ atlas api clusters deleteCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one cluster from the specified project. +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. + +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 b736dab06b..ba3368dc33 100644 --- a/docs/command/atlas-api-clusters-getCluster.txt +++ b/docs/command/atlas-api-clusters-getCluster.txt @@ -12,7 +12,10 @@ atlas api clusters getCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details for one cluster in the specified project. +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. + +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 2870c387fa..5ea98523a5 100644 --- a/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt +++ b/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt @@ -12,7 +12,10 @@ atlas api clusters getClusterAdvancedConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the advanced configuration details for one cluster in the specified project. +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. + +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 535fd79060..7bb1e0f6c9 100644 --- a/docs/command/atlas-api-clusters-getClusterStatus.txt +++ b/docs/command/atlas-api-clusters-getClusterStatus.txt @@ -12,7 +12,10 @@ atlas api clusters getClusterStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the status of all changes that you made to the specified cluster in the specified project. +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. + +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 abee87db9b..1f26c9ae42 100644 --- a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt +++ b/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt @@ -12,7 +12,10 @@ atlas api clusters getSampleDatasetLoadStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Checks the progress of loading the sample dataset into one cluster. +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. + +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 6d15796ab0..29a4ce5905 100644 --- a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt +++ b/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt @@ -12,7 +12,10 @@ atlas api clusters grantMongoDbEmployeeAccess :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/grantMongoDbEmployeeAccess. diff --git a/docs/command/atlas-api-clusters-listCloudProviderRegions.txt b/docs/command/atlas-api-clusters-listCloudProviderRegions.txt index df8621c268..5c5aaa16f2 100644 --- a/docs/command/atlas-api-clusters-listCloudProviderRegions.txt +++ b/docs/command/atlas-api-clusters-listCloudProviderRegions.txt @@ -12,7 +12,10 @@ atlas api clusters listCloudProviderRegions :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the list of regions available for the specified cloud provider at the specified tier. +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. + +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 e51bfb729b..a7021b24c0 100644 --- a/docs/command/atlas-api-clusters-listClusters.txt +++ b/docs/command/atlas-api-clusters-listClusters.txt @@ -12,7 +12,10 @@ atlas api clusters listClusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details for all clusters in the specific project to which you have 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. + +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 eb9ec215a5..a3f08b89f6 100644 --- a/docs/command/atlas-api-clusters-listClustersForAllProjects.txt +++ b/docs/command/atlas-api-clusters-listClustersForAllProjects.txt @@ -12,7 +12,10 @@ atlas api clusters listClustersForAllProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details for all clusters in all projects to which you have 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. + +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 5d69af2b77..966659747b 100644 --- a/docs/command/atlas-api-clusters-loadSampleDataset.txt +++ b/docs/command/atlas-api-clusters-loadSampleDataset.txt @@ -12,7 +12,10 @@ atlas api clusters loadSampleDataset :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Requests loading the MongoDB sample dataset into the specified cluster. +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. + +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 9ffd7785c1..538bf304d4 100644 --- a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt +++ b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt @@ -12,7 +12,10 @@ atlas api clusters pinFeatureCompatibilityVersion :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. +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. + +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 7b9fd45270..e8f9a4ac5d 100644 --- a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt +++ b/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt @@ -12,7 +12,10 @@ atlas api clusters revokeMongoDbEmployeeAccess :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Revokes a previously granted MongoDB employee cluster 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. + +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/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/revokeMongoDbEmployeeAccess. diff --git a/docs/command/atlas-api-clusters-testFailover.txt b/docs/command/atlas-api-clusters-testFailover.txt index 1824968938..f99776d74c 100644 --- a/docs/command/atlas-api-clusters-testFailover.txt +++ b/docs/command/atlas-api-clusters-testFailover.txt @@ -12,7 +12,10 @@ atlas api clusters testFailover :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Starts a failover test for the specified cluster in the specified project. +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. + +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 89b793d1ae..e52e73c49b 100644 --- a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt +++ b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt @@ -12,7 +12,10 @@ atlas api clusters unpinFeatureCompatibilityVersion :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Unpins the current fixed Feature Compatibility Version (FCV). +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. + +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 0cf0556dbd..4c824e74af 100644 --- a/docs/command/atlas-api-clusters-updateCluster.txt +++ b/docs/command/atlas-api-clusters-updateCluster.txt @@ -12,7 +12,10 @@ atlas api clusters updateCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the details for one cluster in the specified project. +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. + +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 e1d76bd206..bec3a00272 100644 --- a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt +++ b/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt @@ -12,7 +12,10 @@ atlas api clusters updateClusterAdvancedConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the advanced configuration details for one cluster in the specified project. +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. + +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 804ed158a2..a8e471cbc3 100644 --- a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt +++ b/docs/command/atlas-api-clusters-upgradeSharedCluster.txt @@ -12,7 +12,10 @@ atlas api clusters upgradeSharedCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. +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. + +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 3a515820fe..08bfffa7ac 100644 --- a/docs/command/atlas-api-clusters.txt +++ b/docs/command/atlas-api-clusters.txt @@ -12,7 +12,10 @@ atlas api clusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes database deployments. +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. + +Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID. @@ -51,25 +54,82 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-clusters-autoScalingConfiguration` - `Public Preview: please provide feedback at `_: Returns the internal configuration of AutoScaling for sharded clusters. -* :ref:`atlas-api-clusters-createCluster` - `Public Preview: please provide feedback at `_: Creates one cluster in the specified project. -* :ref:`atlas-api-clusters-deleteCluster` - `Public Preview: please provide feedback at `_: Removes one cluster from the specified project. -* :ref:`atlas-api-clusters-getCluster` - `Public Preview: please provide feedback at `_: Returns the details for one cluster in the specified project. -* :ref:`atlas-api-clusters-getClusterAdvancedConfiguration` - `Public Preview: please provide feedback at `_: Returns the advanced configuration details for one cluster in the specified project. -* :ref:`atlas-api-clusters-getClusterStatus` - `Public Preview: please provide feedback at `_: 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 at `_: Checks the progress of loading the sample dataset into one cluster. -* :ref:`atlas-api-clusters-grantMongoDbEmployeeAccess` - `Public Preview: please provide feedback at `_: 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 at `_: 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 at `_: 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 at `_: Returns the details for all clusters in all projects to which you have access. -* :ref:`atlas-api-clusters-loadSampleDataset` - `Public Preview: please provide feedback at `_: Requests loading the MongoDB sample dataset into the specified cluster. -* :ref:`atlas-api-clusters-pinFeatureCompatibilityVersion` - `Public Preview: please provide feedback at `_: 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 at `_: Revokes a previously granted MongoDB employee cluster access. -* :ref:`atlas-api-clusters-testFailover` - `Public Preview: please provide feedback at `_: Starts a failover test for the specified cluster in the specified project. -* :ref:`atlas-api-clusters-unpinFeatureCompatibilityVersion` - `Public Preview: please provide feedback at `_: Unpins the current fixed Feature Compatibility Version (FCV). -* :ref:`atlas-api-clusters-updateCluster` - `Public Preview: please provide feedback at `_: Updates the details for one cluster in the specified project. -* :ref:`atlas-api-clusters-updateClusterAdvancedConfiguration` - `Public Preview: please provide feedback at `_: Updates the advanced configuration details for one cluster in the specified project. -* :ref:`atlas-api-clusters-upgradeSharedCluster` - `Public Preview: please provide feedback at `_: Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. +* :ref:`atlas-api-clusters-autoScalingConfiguration` - 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. + +Returns the internal configuration of AutoScaling for sharded clusters. +* :ref:`atlas-api-clusters-createCluster` - 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. + +Creates one cluster in the specified project. +* :ref:`atlas-api-clusters-deleteCluster` - 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. + +Removes one cluster from the specified project. +* :ref:`atlas-api-clusters-getCluster` - 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. + +Returns the details for one cluster in the specified project. +* :ref:`atlas-api-clusters-getClusterAdvancedConfiguration` - 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. + +Returns the advanced configuration details for one cluster in the specified project. +* :ref:`atlas-api-clusters-getClusterStatus` - 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. + +Returns the status of all changes that you made to the specified cluster in the specified project. +* :ref:`atlas-api-clusters-getSampleDatasetLoadStatus` - 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. + +Checks the progress of loading the sample dataset into one cluster. +* :ref:`atlas-api-clusters-grantMongoDbEmployeeAccess` - 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. + +Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. +* :ref:`atlas-api-clusters-listCloudProviderRegions` - 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. + +Returns the list of regions available for the specified cloud provider at the specified tier. +* :ref:`atlas-api-clusters-listClusters` - 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. + +Returns the details for all clusters in the specific project to which you have access. +* :ref:`atlas-api-clusters-listClustersForAllProjects` - 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. + +Returns the details for all clusters in all projects to which you have access. +* :ref:`atlas-api-clusters-loadSampleDataset` - 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. + +Requests loading the MongoDB sample dataset into the specified cluster. +* :ref:`atlas-api-clusters-pinFeatureCompatibilityVersion` - 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. + +Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. +* :ref:`atlas-api-clusters-revokeMongoDbEmployeeAccess` - 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. + +Revokes a previously granted MongoDB employee cluster access. +* :ref:`atlas-api-clusters-testFailover` - 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. + +Starts a failover test for the specified cluster in the specified project. +* :ref:`atlas-api-clusters-unpinFeatureCompatibilityVersion` - 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. + +Unpins the current fixed Feature Compatibility Version (FCV). +* :ref:`atlas-api-clusters-updateCluster` - 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. + +Updates the details for one cluster in the specified project. +* :ref:`atlas-api-clusters-updateClusterAdvancedConfiguration` - 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. + +Updates the advanced configuration details for one cluster in the specified project. +* :ref:`atlas-api-clusters-upgradeSharedCluster` - 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. + +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 847ae8b9c5..ca6cdffc0d 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt @@ -12,7 +12,10 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceClusterMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceClusterMeasurements. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt index b3ee5fbe45..22c6f4eb7a 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt @@ -12,7 +12,10 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceHostMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Get a list of the Coll Stats Latency process-level measurements for the given namespace. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceHostMeasurements. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt index 2eea1dc05b..62b8966759 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt @@ -12,7 +12,10 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespaceMetrics :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceMetrics. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt index 87b67830c6..bf9d728080 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt @@ -12,7 +12,10 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForCluster. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt index c6bd756c49..4ee5f712d7 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt @@ -12,7 +12,10 @@ atlas api collectionLevelMetrics getCollStatsLatencyNamespacesForHost :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForHost. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt index 04524f4453..682e254165 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt @@ -12,7 +12,10 @@ atlas api collectionLevelMetrics getPinnedNamespaces :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getPinnedNamespaces. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt index cfb1b352bc..64f10f4862 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt @@ -12,7 +12,10 @@ atlas api collectionLevelMetrics pinNamespacesPatch :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPatch. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt index 6bfd555efc..d3c41e77ce 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt @@ -12,7 +12,10 @@ atlas api collectionLevelMetrics pinNamespacesPut :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +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. + +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 4abbaaaca2..e5d58f97b0 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt @@ -12,7 +12,10 @@ atlas api collectionLevelMetrics unpinNamespaces :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/unpinNamespaces. diff --git a/docs/command/atlas-api-collectionLevelMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics.txt index 5ec03b981d..a4e805c586 100644 --- a/docs/command/atlas-api-collectionLevelMetrics.txt +++ b/docs/command/atlas-api-collectionLevelMetrics.txt @@ -12,7 +12,10 @@ atlas api collectionLevelMetrics :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, and edits pinned namespaces for the specified cluster or process. +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. + +Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level latency metric data. @@ -51,15 +54,42 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements` - `Public Preview: please provide feedback at `_: 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 at `_: 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 at `_: 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 at `_: 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 at `_: 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 at `_: 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 at `_: 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 at `_: 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 at `_: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements` - 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. + +Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements` - 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. + +Get a list of the Coll Stats Latency process-level measurements for the given namespace. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics` - 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. + +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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost` - 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. + +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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPatch` - 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. + +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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +* :ref:`atlas-api-collectionLevelMetrics-unpinNamespaces` - 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. + +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 e9647ea3dd..a2bd7229eb 100644 --- a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt @@ -12,7 +12,10 @@ atlas api customDatabaseRoles createCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one custom role in the specified project. +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. + +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 bd77a4e37a..08d3f84fdf 100644 --- a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt @@ -12,7 +12,10 @@ atlas api customDatabaseRoles deleteCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one custom role from the specified project. +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. + +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 cccd26e63f..7914bc0f29 100644 --- a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt @@ -12,7 +12,10 @@ atlas api customDatabaseRoles getCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one custom role for the specified project. +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. + +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 911ab13a1e..3084ced022 100644 --- a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt +++ b/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt @@ -12,7 +12,10 @@ atlas api customDatabaseRoles listCustomDatabaseRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all custom roles for the specified project. +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. + +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 3b643f8ea0..b87886e8ba 100644 --- a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt @@ -12,7 +12,10 @@ atlas api customDatabaseRoles updateCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one custom role in the specified project. +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. + +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 bb0a0b3c7b..b6ea6ac22d 100644 --- a/docs/command/atlas-api-customDatabaseRoles.txt +++ b/docs/command/atlas-api-customDatabaseRoles.txt @@ -12,7 +12,10 @@ atlas api customDatabaseRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes custom database user privilege roles. +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. + +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. @@ -51,11 +54,26 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-customDatabaseRoles-createCustomDatabaseRole` - `Public Preview: please provide feedback at `_: Creates one custom role in the specified project. -* :ref:`atlas-api-customDatabaseRoles-deleteCustomDatabaseRole` - `Public Preview: please provide feedback at `_: Removes one custom role from the specified project. -* :ref:`atlas-api-customDatabaseRoles-getCustomDatabaseRole` - `Public Preview: please provide feedback at `_: Returns one custom role for the specified project. -* :ref:`atlas-api-customDatabaseRoles-listCustomDatabaseRoles` - `Public Preview: please provide feedback at `_: Returns all custom roles for the specified project. -* :ref:`atlas-api-customDatabaseRoles-updateCustomDatabaseRole` - `Public Preview: please provide feedback at `_: Updates one custom role in the specified project. +* :ref:`atlas-api-customDatabaseRoles-createCustomDatabaseRole` - 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. + +Creates one custom role in the specified project. +* :ref:`atlas-api-customDatabaseRoles-deleteCustomDatabaseRole` - 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. + +Removes one custom role from the specified project. +* :ref:`atlas-api-customDatabaseRoles-getCustomDatabaseRole` - 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. + +Returns one custom role for the specified project. +* :ref:`atlas-api-customDatabaseRoles-listCustomDatabaseRoles` - 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. + +Returns all custom roles for the specified project. +* :ref:`atlas-api-customDatabaseRoles-updateCustomDatabaseRole` - 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. + +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 0939a336dd..d8b4d5e17a 100644 --- a/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt @@ -12,7 +12,10 @@ atlas api dataFederation createDataFederationPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. +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. + +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 b4e6d1b036..43c09f2d30 100644 --- a/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt @@ -12,7 +12,10 @@ atlas api dataFederation createFederatedDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one federated database instance in the specified project. +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. + +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 8b4107f747..070038bca1 100644 --- a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt @@ -12,7 +12,10 @@ atlas api dataFederation createOneDataFederationQueryLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates or updates one query limit for one federated database instance. +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. + +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 3b0da301ab..3a57eb3a0b 100644 --- a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt @@ -12,7 +12,10 @@ atlas api dataFederation deleteDataFederationPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. +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. + +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 be5b337232..bc6c60fe98 100644 --- a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt @@ -12,7 +12,10 @@ atlas api dataFederation deleteFederatedDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one federated database instance from the specified project. +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. + +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 0e460664b8..67f492ca9c 100644 --- a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt @@ -12,7 +12,10 @@ atlas api dataFederation deleteOneDataFederationInstanceQueryLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes one query limit for one federated database instance. +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. + +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 698033d4a1..99d17c7926 100644 --- a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt +++ b/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt @@ -12,7 +12,10 @@ atlas api dataFederation downloadFederatedDatabaseQueryLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Downloads the query logs for the specified federated database instance. +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. + +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 671b3be29e..5b220e0a8f 100644 --- a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt @@ -12,7 +12,10 @@ atlas api dataFederation getDataFederationPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. +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. + +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 edae70a753..87b63ee2a3 100644 --- a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt @@ -12,7 +12,10 @@ atlas api dataFederation getFederatedDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one federated database instance within the specified project. +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. + +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 52cc26b021..9341739fed 100644 --- a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt +++ b/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt @@ -12,7 +12,10 @@ atlas api dataFederation listDataFederationPrivateEndpoints :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. +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. + +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 9224915bcf..9db56d6b4f 100644 --- a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt +++ b/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt @@ -12,7 +12,10 @@ atlas api dataFederation listFederatedDatabases :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of all federated database instances in the specified project. +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. + +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 22b77adc8f..75dbbc3c1c 100644 --- a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt @@ -12,7 +12,10 @@ atlas api dataFederation returnFederatedDatabaseQueryLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one query limit for the specified federated database instance in the specified project. +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. + +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 f85a5b6548..d06a6e69d3 100644 --- a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt +++ b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt @@ -12,7 +12,10 @@ atlas api dataFederation returnFederatedDatabaseQueryLimits :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns query limits for a federated databases instance in the specified project. +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. + +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 7d786b4a5b..c66e79703e 100644 --- a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt @@ -12,7 +12,10 @@ atlas api dataFederation updateFederatedDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the details of one federated database instance in the specified project. +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. + +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 ba6872e585..596eea538d 100644 --- a/docs/command/atlas-api-dataFederation.txt +++ b/docs/command/atlas-api-dataFederation.txt @@ -12,7 +12,10 @@ atlas api dataFederation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes Federated Database Instances. +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. + +Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs. @@ -51,20 +54,62 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-dataFederation-createDataFederationPrivateEndpoint` - `Public Preview: please provide feedback at `_: 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 at `_: Creates one federated database instance in the specified project. -* :ref:`atlas-api-dataFederation-createOneDataFederationQueryLimit` - `Public Preview: please provide feedback at `_: Creates or updates one query limit for one federated database instance. -* :ref:`atlas-api-dataFederation-deleteDataFederationPrivateEndpoint` - `Public Preview: please provide feedback at `_: 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 at `_: Removes one federated database instance from the specified project. -* :ref:`atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit` - `Public Preview: please provide feedback at `_: Deletes one query limit for one federated database instance. -* :ref:`atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs` - `Public Preview: please provide feedback at `_: Downloads the query logs for the specified federated database instance. -* :ref:`atlas-api-dataFederation-getDataFederationPrivateEndpoint` - `Public Preview: please provide feedback at `_: 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 at `_: Returns the details of one federated database instance within the specified project. -* :ref:`atlas-api-dataFederation-listDataFederationPrivateEndpoints` - `Public Preview: please provide feedback at `_: 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 at `_: Returns the details of all federated database instances in the specified project. -* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimit` - `Public Preview: please provide feedback at `_: 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 at `_: Returns query limits for a federated databases instance in the specified project. -* :ref:`atlas-api-dataFederation-updateFederatedDatabase` - `Public Preview: please provide feedback at `_: Updates the details of one federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-createDataFederationPrivateEndpoint` - 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. + +Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. +* :ref:`atlas-api-dataFederation-createFederatedDatabase` - 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. + +Creates one federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-createOneDataFederationQueryLimit` - 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. + +Creates or updates one query limit for one federated database instance. +* :ref:`atlas-api-dataFederation-deleteDataFederationPrivateEndpoint` - 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. + +Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-deleteFederatedDatabase` - 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. + +Removes one federated database instance from the specified project. +* :ref:`atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit` - 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. + +Deletes one query limit for one federated database instance. +* :ref:`atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs` - 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. + +Downloads the query logs for the specified federated database instance. +* :ref:`atlas-api-dataFederation-getDataFederationPrivateEndpoint` - 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. + +Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-getFederatedDatabase` - 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. + +Returns the details of one federated database instance within the specified project. +* :ref:`atlas-api-dataFederation-listDataFederationPrivateEndpoints` - 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. + +Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-listFederatedDatabases` - 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. + +Returns the details of all federated database instances in the specified project. +* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimit` - 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. + +Returns the details of one query limit for the specified federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimits` - 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. + +Returns query limits for a federated databases instance in the specified project. +* :ref:`atlas-api-dataFederation-updateFederatedDatabase` - 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. + +Updates the details of one federated database instance in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-dataLakePipelines-createPipeline.txt b/docs/command/atlas-api-dataLakePipelines-createPipeline.txt index 59b73da42e..95467db832 100644 --- a/docs/command/atlas-api-dataLakePipelines-createPipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-createPipeline.txt @@ -12,7 +12,10 @@ atlas api dataLakePipelines createPipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one Data Lake Pipeline. +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. + +Creates one Data Lake Pipeline. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/createPipeline. diff --git a/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt b/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt index ccb06b4131..f1c37c01fb 100644 --- a/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt @@ -12,7 +12,10 @@ atlas api dataLakePipelines deletePipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one Data Lake Pipeline. +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. + +Removes one Data Lake Pipeline. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipeline. diff --git a/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt b/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt index 0cbd3549be..20b077da01 100644 --- a/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt +++ b/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt @@ -12,7 +12,10 @@ atlas api dataLakePipelines deletePipelineRunDataset :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes dataset that Atlas generated during the specified pipeline run. +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. + +Deletes dataset that Atlas generated during the specified pipeline run. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipelineRunDataset. diff --git a/docs/command/atlas-api-dataLakePipelines-getPipeline.txt b/docs/command/atlas-api-dataLakePipelines-getPipeline.txt index f37335bbf5..286fd30a98 100644 --- a/docs/command/atlas-api-dataLakePipelines-getPipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-getPipeline.txt @@ -12,7 +12,10 @@ atlas api dataLakePipelines getPipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one Data Lake Pipeline within the specified project. +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. + +Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt b/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt index fc55f00eef..d5eb4716b9 100644 --- a/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt +++ b/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt @@ -12,7 +12,10 @@ atlas api dataLakePipelines getPipelineRun :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one Data Lake Pipeline run within the specified project. +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. + +Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt index 50ba5ae7b9..e0d5f06dc5 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt @@ -12,7 +12,10 @@ atlas api dataLakePipelines listPipelineRuns :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of past Data Lake Pipeline runs. +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. + +Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt index 697b593217..8aa9b79ed4 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt @@ -12,7 +12,10 @@ atlas api dataLakePipelines listPipelineSchedules :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. +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. + +Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt index daec0a0d77..cbf8385c79 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt @@ -12,7 +12,10 @@ atlas api dataLakePipelines listPipelineSnapshots :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. +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. + +Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelines.txt b/docs/command/atlas-api-dataLakePipelines-listPipelines.txt index 5c71178c35..c217da3888 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelines.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelines.txt @@ -12,7 +12,10 @@ atlas api dataLakePipelines listPipelines :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of Data Lake Pipelines. +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. + +Returns a list of Data Lake Pipelines. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt b/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt index c3df9dc7cc..cf2e555711 100644 --- a/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt @@ -12,7 +12,10 @@ atlas api dataLakePipelines pausePipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Pauses ingestion for a Data Lake Pipeline within the specified project. +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. + +Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt b/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt index 3cd8bb0d77..8bfc108ec2 100644 --- a/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt @@ -12,7 +12,10 @@ atlas api dataLakePipelines resumePipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Resumes ingestion for a Data Lake Pipeline within the specified project. +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. + +Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt b/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt index c0f65e0055..26237af27f 100644 --- a/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt +++ b/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt @@ -12,7 +12,10 @@ atlas api dataLakePipelines triggerSnapshotIngestion :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Triggers a Data Lake Pipeline ingestion of a specified snapshot. +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. + +Triggers a Data Lake Pipeline ingestion of a specified snapshot. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/triggerSnapshotIngestion. diff --git a/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt b/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt index b7ac25dcd7..dd9c8d9d39 100644 --- a/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt @@ -12,7 +12,10 @@ atlas api dataLakePipelines updatePipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one Data Lake Pipeline. +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. + +Updates one Data Lake Pipeline. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/updatePipeline. diff --git a/docs/command/atlas-api-dataLakePipelines.txt b/docs/command/atlas-api-dataLakePipelines.txt index 46f5e1e586..61aa7c873a 100644 --- a/docs/command/atlas-api-dataLakePipelines.txt +++ b/docs/command/atlas-api-dataLakePipelines.txt @@ -12,7 +12,10 @@ atlas api dataLakePipelines :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. +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. + +Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. Options ------- @@ -49,19 +52,58 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-dataLakePipelines-createPipeline` - `Public Preview: please provide feedback at `_: Creates one Data Lake Pipeline. -* :ref:`atlas-api-dataLakePipelines-deletePipeline` - `Public Preview: please provide feedback at `_: Removes one Data Lake Pipeline. -* :ref:`atlas-api-dataLakePipelines-deletePipelineRunDataset` - `Public Preview: please provide feedback at `_: Deletes dataset that Atlas generated during the specified pipeline run. -* :ref:`atlas-api-dataLakePipelines-getPipeline` - `Public Preview: please provide feedback at `_: Returns the details of one Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-getPipelineRun` - `Public Preview: please provide feedback at `_: Returns the details of one Data Lake Pipeline run within the specified project. -* :ref:`atlas-api-dataLakePipelines-listPipelineRuns` - `Public Preview: please provide feedback at `_: Returns a list of past Data Lake Pipeline runs. -* :ref:`atlas-api-dataLakePipelines-listPipelineSchedules` - `Public Preview: please provide feedback at `_: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. -* :ref:`atlas-api-dataLakePipelines-listPipelineSnapshots` - `Public Preview: please provide feedback at `_: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. -* :ref:`atlas-api-dataLakePipelines-listPipelines` - `Public Preview: please provide feedback at `_: Returns a list of Data Lake Pipelines. -* :ref:`atlas-api-dataLakePipelines-pausePipeline` - `Public Preview: please provide feedback at `_: Pauses ingestion for a Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-resumePipeline` - `Public Preview: please provide feedback at `_: Resumes ingestion for a Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-triggerSnapshotIngestion` - `Public Preview: please provide feedback at `_: Triggers a Data Lake Pipeline ingestion of a specified snapshot. -* :ref:`atlas-api-dataLakePipelines-updatePipeline` - `Public Preview: please provide feedback at `_: Updates one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-createPipeline` - 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. + +Creates one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-deletePipeline` - 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. + +Removes one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-deletePipelineRunDataset` - 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. + +Deletes dataset that Atlas generated during the specified pipeline run. +* :ref:`atlas-api-dataLakePipelines-getPipeline` - 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. + +Returns the details of one Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-getPipelineRun` - 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. + +Returns the details of one Data Lake Pipeline run within the specified project. +* :ref:`atlas-api-dataLakePipelines-listPipelineRuns` - 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. + +Returns a list of past Data Lake Pipeline runs. +* :ref:`atlas-api-dataLakePipelines-listPipelineSchedules` - 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. + +Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. +* :ref:`atlas-api-dataLakePipelines-listPipelineSnapshots` - 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. + +Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. +* :ref:`atlas-api-dataLakePipelines-listPipelines` - 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. + +Returns a list of Data Lake Pipelines. +* :ref:`atlas-api-dataLakePipelines-pausePipeline` - 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. + +Pauses ingestion for a Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-resumePipeline` - 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. + +Resumes ingestion for a Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-triggerSnapshotIngestion` - 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. + +Triggers a Data Lake Pipeline ingestion of a specified snapshot. +* :ref:`atlas-api-dataLakePipelines-updatePipeline` - 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. + +Updates one Data Lake Pipeline. .. toctree:: diff --git a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt index a6bd2acc2a..b3da053fb6 100644 --- a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt @@ -12,7 +12,10 @@ atlas api databaseUsers createDatabaseUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one database user in the specified project. +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. + +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 c4d2a4d426..320da160e2 100644 --- a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt @@ -12,7 +12,10 @@ atlas api databaseUsers deleteDatabaseUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one database user from the specified project. +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. + +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 b7259ada47..11cb57e50e 100644 --- a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt @@ -12,7 +12,10 @@ atlas api databaseUsers getDatabaseUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one database user that belong to the specified project. +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. + +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 ac17229b97..cca58eaec5 100644 --- a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt +++ b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt @@ -12,7 +12,10 @@ atlas api databaseUsers listDatabaseUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all database users that belong to the specified project. +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. + +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 428cb4e2e4..52637c8840 100644 --- a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt @@ -12,7 +12,10 @@ atlas api databaseUsers updateDatabaseUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one database user that belongs to the specified project. +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. + +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 946715b80a..e22e5955be 100644 --- a/docs/command/atlas-api-databaseUsers.txt +++ b/docs/command/atlas-api-databaseUsers.txt @@ -12,7 +12,10 @@ atlas api databaseUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes database users. +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. + +Returns, adds, edits, and removes database users. Options ------- @@ -49,11 +52,26 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-databaseUsers-createDatabaseUser` - `Public Preview: please provide feedback at `_: Creates one database user in the specified project. -* :ref:`atlas-api-databaseUsers-deleteDatabaseUser` - `Public Preview: please provide feedback at `_: Removes one database user from the specified project. -* :ref:`atlas-api-databaseUsers-getDatabaseUser` - `Public Preview: please provide feedback at `_: Returns one database user that belong to the specified project. -* :ref:`atlas-api-databaseUsers-listDatabaseUsers` - `Public Preview: please provide feedback at `_: Returns all database users that belong to the specified project. -* :ref:`atlas-api-databaseUsers-updateDatabaseUser` - `Public Preview: please provide feedback at `_: Updates one database user that belongs to the specified project. +* :ref:`atlas-api-databaseUsers-createDatabaseUser` - 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. + +Creates one database user in the specified project. +* :ref:`atlas-api-databaseUsers-deleteDatabaseUser` - 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. + +Removes one database user from the specified project. +* :ref:`atlas-api-databaseUsers-getDatabaseUser` - 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. + +Returns one database user that belong to the specified project. +* :ref:`atlas-api-databaseUsers-listDatabaseUsers` - 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. + +Returns all database users that belong to the specified project. +* :ref:`atlas-api-databaseUsers-updateDatabaseUser` - 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. + +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 42b092a3ec..48d2ba6989 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt @@ -12,7 +12,10 @@ atlas api encryptionAtRestUsingCustomerKeyManagement createEncryptionAtRestPriva :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates a private endpoint in the specified region for encryption at rest using customer key management. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/createEncryptionAtRestPrivateEndpoint. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt index e087e0a706..79584bdd71 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt @@ -12,7 +12,10 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRest :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. +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. + +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 94f3ca9398..40c4b9d0d8 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt @@ -12,7 +12,10 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateE :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpoint. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt index 15160f38b6..dc785fcd92 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt @@ -12,7 +12,10 @@ atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateE :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpointsForCloudProvider. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt index a9735658f4..0d21684152 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt @@ -12,7 +12,10 @@ atlas api encryptionAtRestUsingCustomerKeyManagement requestEncryptionAtRestPriv :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/requestEncryptionAtRestPrivateEndpointDeletion. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt index 97ad183d60..0858e65734 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt @@ -12,7 +12,10 @@ atlas api encryptionAtRestUsingCustomerKeyManagement updateEncryptionAtRest :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. +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. + +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 de3690c02f..370ca5ea60 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt @@ -12,7 +12,10 @@ atlas api encryptionAtRestUsingCustomerKeyManagement :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and edits the Encryption at Rest using Customer Key Management configuration. +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. + +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. @@ -51,12 +54,30 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint` - `Public Preview: please provide feedback at `_: 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 at `_: 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 at `_: 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 at `_: 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 at `_: 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 at `_: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint` - 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. + +Creates a private endpoint in the specified region for encryption at rest using customer key management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest` - 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. + +Returns the configuration for encryption at rest using the keys you manage through your cloud provider. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint` - 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. + +Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider` - 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. + +Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion` - 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. + +Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest` - 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. + +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 31319e99bf..17cd3d69e4 100644 --- a/docs/command/atlas-api-events-getOrganizationEvent.txt +++ b/docs/command/atlas-api-events-getOrganizationEvent.txt @@ -12,7 +12,10 @@ atlas api events getOrganizationEvent :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one event for the specified organization. +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. + +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 All 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 952f86ec83..9206b42c9c 100644 --- a/docs/command/atlas-api-events-getProjectEvent.txt +++ b/docs/command/atlas-api-events-getProjectEvent.txt @@ -12,7 +12,10 @@ atlas api events getProjectEvent :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one event for the specified project. +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. + +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 All 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 77cad6d06a..ea1213af13 100644 --- a/docs/command/atlas-api-events-listEventTypes.txt +++ b/docs/command/atlas-api-events-listEventTypes.txt @@ -12,7 +12,10 @@ atlas api events listEventTypes :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of all event types, along with a description and additional metadata about each event. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listEventTypes. diff --git a/docs/command/atlas-api-events-listOrganizationEvents.txt b/docs/command/atlas-api-events-listOrganizationEvents.txt index 1ea011cfaf..d43e6eeabc 100644 --- a/docs/command/atlas-api-events-listOrganizationEvents.txt +++ b/docs/command/atlas-api-events-listOrganizationEvents.txt @@ -12,7 +12,10 @@ atlas api events listOrganizationEvents :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all events for the specified organization. +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. + +Returns all 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 7e26dc8067..f54a725426 100644 --- a/docs/command/atlas-api-events-listProjectEvents.txt +++ b/docs/command/atlas-api-events-listProjectEvents.txt @@ -12,7 +12,10 @@ atlas api events listProjectEvents :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all events for the specified project. +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. + +Returns all 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 d7ffbcbbe5..fbdebcea7c 100644 --- a/docs/command/atlas-api-events.txt +++ b/docs/command/atlas-api-events.txt @@ -12,7 +12,10 @@ atlas api events :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns events. +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. + +Returns events. This collection remains under revision and may change. @@ -51,11 +54,26 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-events-getOrganizationEvent` - `Public Preview: please provide feedback at `_: Returns one event for the specified organization. -* :ref:`atlas-api-events-getProjectEvent` - `Public Preview: please provide feedback at `_: Returns one event for the specified project. -* :ref:`atlas-api-events-listEventTypes` - `Public Preview: please provide feedback at `_: 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 at `_: Returns all events for the specified organization. -* :ref:`atlas-api-events-listProjectEvents` - `Public Preview: please provide feedback at `_: Returns all events for the specified project. +* :ref:`atlas-api-events-getOrganizationEvent` - 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. + +Returns one event for the specified organization. +* :ref:`atlas-api-events-getProjectEvent` - 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. + +Returns one event for the specified project. +* :ref:`atlas-api-events-listEventTypes` - 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. + +Returns a list of all event types, along with a description and additional metadata about each event. +* :ref:`atlas-api-events-listOrganizationEvents` - 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. + +Returns all events for the specified organization. +* :ref:`atlas-api-events-listProjectEvents` - 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. + +Returns all 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 f80b82769e..ebdc465347 100644 --- a/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication createIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one identity provider within the specified federation. +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. + +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 17d155ee5d..5d56d0e7d4 100644 --- a/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication createRoleMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one role mapping to the specified organization in the specified federation. +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. + +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 419f1b582b..8609ecacc1 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication deleteFederationApp :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes the federation settings instance and all associated data, including identity providers and domains. +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. + +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 a924fe337a..79a3840b19 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication deleteIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes one identity provider in the specified federation. +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. + +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 a9bd457a62..87adb04769 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication deleteRoleMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one role mapping in the specified organization from the specified federation. +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. + +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 f6db8a14de..b2450838b7 100644 --- a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication getConnectedOrgConfig :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the specified connected org config from the specified federation. +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. + +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 f8e800a1d2..814561b7f3 100644 --- a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt +++ b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication getFederationSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns information about the federation settings for the specified organization. +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. + +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 a214d1f3dc..598cb58b2a 100644 --- a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication getIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one identity provider in the specified federation by the identity provider's id. +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. + +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 2cbfa3652d..7fecec2872 100644 --- a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt +++ b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication getIdentityProviderMetadata :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the metadata of one identity provider in the specified federation. +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. + +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 52062478b1..3cd07de431 100644 --- a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication getRoleMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one role mapping from the specified organization in the specified federation. +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. + +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 0d56e97adf..a4f44e405c 100644 --- a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt +++ b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication listConnectedOrgConfigs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all connected org configs in the specified federation. +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. + +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 02286287e6..b3fceed71b 100644 --- a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt +++ b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication listIdentityProviders :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all identity providers with the provided protocol and type in the specified federation. +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. + +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 1c41a8901b..2ce3439c6d 100644 --- a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt +++ b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication listRoleMappings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all role mappings from the specified organization in the specified federation. +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. + +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 2afb49091b..bea878eaa2 100644 --- a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication removeConnectedOrgConfig :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one connected organization configuration from the specified federation. +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. + +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 27e0bb7063..1d97de6718 100644 --- a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication revokeJwksFromIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Revokes the JWKS tokens from the requested OIDC identity provider. +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. + +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 4121f24964..9bdfd05065 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication updateConnectedOrgConfig :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one connected organization configuration from the specified federation. +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. + +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 a51f6fa936..b641dcbd18 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication updateIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one identity provider in the specified federation. +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. + +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 e301dbe3c4..917af48438 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication updateRoleMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one role mapping in the specified organization in the specified federation. +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. + +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 7c46230652..1690855798 100644 --- a/docs/command/atlas-api-federatedAuthentication.txt +++ b/docs/command/atlas-api-federatedAuthentication.txt @@ -12,7 +12,10 @@ atlas api federatedAuthentication :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. +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. + +Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. Options ------- @@ -49,24 +52,78 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-federatedAuthentication-createIdentityProvider` - `Public Preview: please provide feedback at `_: Creates one identity provider within the specified federation. -* :ref:`atlas-api-federatedAuthentication-createRoleMapping` - `Public Preview: please provide feedback at `_: Adds one role mapping to the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-deleteFederationApp` - `Public Preview: please provide feedback at `_: Deletes the federation settings instance and all associated data, including identity providers and domains. -* :ref:`atlas-api-federatedAuthentication-deleteIdentityProvider` - `Public Preview: please provide feedback at `_: Deletes one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-deleteRoleMapping` - `Public Preview: please provide feedback at `_: Removes one role mapping in the specified organization from the specified federation. -* :ref:`atlas-api-federatedAuthentication-getConnectedOrgConfig` - `Public Preview: please provide feedback at `_: Returns the specified connected org config from the specified federation. -* :ref:`atlas-api-federatedAuthentication-getFederationSettings` - `Public Preview: please provide feedback at `_: Returns information about the federation settings for the specified organization. -* :ref:`atlas-api-federatedAuthentication-getIdentityProvider` - `Public Preview: please provide feedback at `_: Returns one identity provider in the specified federation by the identity provider's id. -* :ref:`atlas-api-federatedAuthentication-getIdentityProviderMetadata` - `Public Preview: please provide feedback at `_: Returns the metadata of one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-getRoleMapping` - `Public Preview: please provide feedback at `_: Returns one role mapping from the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listConnectedOrgConfigs` - `Public Preview: please provide feedback at `_: Returns all connected org configs in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listIdentityProviders` - `Public Preview: please provide feedback at `_: Returns all identity providers with the provided protocol and type in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listRoleMappings` - `Public Preview: please provide feedback at `_: Returns all role mappings from the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-removeConnectedOrgConfig` - `Public Preview: please provide feedback at `_: Removes one connected organization configuration from the specified federation. -* :ref:`atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider` - `Public Preview: please provide feedback at `_: Revokes the JWKS tokens from the requested OIDC identity provider. -* :ref:`atlas-api-federatedAuthentication-updateConnectedOrgConfig` - `Public Preview: please provide feedback at `_: Updates one connected organization configuration from the specified federation. -* :ref:`atlas-api-federatedAuthentication-updateIdentityProvider` - `Public Preview: please provide feedback at `_: Updates one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-updateRoleMapping` - `Public Preview: please provide feedback at `_: Updates one role mapping in the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-createIdentityProvider` - 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. + +Creates one identity provider within the specified federation. +* :ref:`atlas-api-federatedAuthentication-createRoleMapping` - 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. + +Adds one role mapping to the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-deleteFederationApp` - 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. + +Deletes the federation settings instance and all associated data, including identity providers and domains. +* :ref:`atlas-api-federatedAuthentication-deleteIdentityProvider` - 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. + +Deletes one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-deleteRoleMapping` - 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. + +Removes one role mapping in the specified organization from the specified federation. +* :ref:`atlas-api-federatedAuthentication-getConnectedOrgConfig` - 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. + +Returns the specified connected org config from the specified federation. +* :ref:`atlas-api-federatedAuthentication-getFederationSettings` - 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. + +Returns information about the federation settings for the specified organization. +* :ref:`atlas-api-federatedAuthentication-getIdentityProvider` - 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. + +Returns one identity provider in the specified federation by the identity provider's id. +* :ref:`atlas-api-federatedAuthentication-getIdentityProviderMetadata` - 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. + +Returns the metadata of one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-getRoleMapping` - 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. + +Returns one role mapping from the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listConnectedOrgConfigs` - 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. + +Returns all connected org configs in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listIdentityProviders` - 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. + +Returns all identity providers with the provided protocol and type in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listRoleMappings` - 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. + +Returns all role mappings from the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-removeConnectedOrgConfig` - 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. + +Removes one connected organization configuration from the specified federation. +* :ref:`atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider` - 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. + +Revokes the JWKS tokens from the requested OIDC identity provider. +* :ref:`atlas-api-federatedAuthentication-updateConnectedOrgConfig` - 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. + +Updates one connected organization configuration from the specified federation. +* :ref:`atlas-api-federatedAuthentication-updateIdentityProvider` - 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. + +Updates one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-updateRoleMapping` - 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. + +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 8942d71b73..6260f99391 100644 --- a/docs/command/atlas-api-flexClusters-createFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-createFlexCluster.txt @@ -12,7 +12,10 @@ atlas api flexClusters createFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one flex cluster in the specified project. +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. + +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 6cae34458c..1287ccf74e 100644 --- a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt @@ -12,7 +12,10 @@ atlas api flexClusters deleteFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one flex cluster from the specified project. +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. + +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 0e85995b02..c21e3e6b19 100644 --- a/docs/command/atlas-api-flexClusters-getFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-getFlexCluster.txt @@ -12,7 +12,10 @@ atlas api flexClusters getFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details for one flex cluster in the specified project. +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. + +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 781344a381..c97d5ca825 100644 --- a/docs/command/atlas-api-flexClusters-listFlexClusters.txt +++ b/docs/command/atlas-api-flexClusters-listFlexClusters.txt @@ -12,7 +12,10 @@ atlas api flexClusters listFlexClusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details for all flex clusters in the specified project. +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. + +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 7f75897962..209ddeeca3 100644 --- a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt @@ -12,7 +12,10 @@ atlas api flexClusters updateFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one flex cluster in the specified project. +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. + +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 6598098c97..2bbf88b3e1 100644 --- a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt @@ -12,7 +12,10 @@ atlas api flexClusters upgradeFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. +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. + +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 59baa45aeb..9b86bc9d24 100644 --- a/docs/command/atlas-api-flexClusters.txt +++ b/docs/command/atlas-api-flexClusters.txt @@ -12,7 +12,10 @@ atlas api flexClusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes flex clusters. +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. + +Returns, adds, edits, and removes flex clusters. Options ------- @@ -49,12 +52,30 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexClusters-createFlexCluster` - `Public Preview: please provide feedback at `_: Creates one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-deleteFlexCluster` - `Public Preview: please provide feedback at `_: Removes one flex cluster from the specified project. -* :ref:`atlas-api-flexClusters-getFlexCluster` - `Public Preview: please provide feedback at `_: Returns details for one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-listFlexClusters` - `Public Preview: please provide feedback at `_: Returns details for all flex clusters in the specified project. -* :ref:`atlas-api-flexClusters-updateFlexCluster` - `Public Preview: please provide feedback at `_: Updates one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-upgradeFlexCluster` - `Public Preview: please provide feedback at `_: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. +* :ref:`atlas-api-flexClusters-createFlexCluster` - 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. + +Creates one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-deleteFlexCluster` - 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. + +Removes one flex cluster from the specified project. +* :ref:`atlas-api-flexClusters-getFlexCluster` - 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. + +Returns details for one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-listFlexClusters` - 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. + +Returns details for all flex clusters in the specified project. +* :ref:`atlas-api-flexClusters-updateFlexCluster` - 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. + +Updates one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-upgradeFlexCluster` - 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. + +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 93c2f9d6a6..dc516fb2ef 100644 --- a/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt +++ b/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt @@ -12,7 +12,10 @@ atlas api flexRestoreJobs createFlexBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Restores one snapshot of one flex cluster from the specified project. +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. + +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 749cb5a137..87121f1cc2 100644 --- a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt +++ b/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt @@ -12,7 +12,10 @@ atlas api flexRestoreJobs getFlexBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one restore job for one flex cluster from the specified project. +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. + +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 fed554366b..45f032f2e6 100644 --- a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt +++ b/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt @@ -12,7 +12,10 @@ atlas api flexRestoreJobs listFlexBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all restore jobs for one flex cluster from the specified project. +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. + +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 6b23cc00ae..52546e47fe 100644 --- a/docs/command/atlas-api-flexRestoreJobs.txt +++ b/docs/command/atlas-api-flexRestoreJobs.txt @@ -12,7 +12,10 @@ atlas api flexRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and adds restore jobs for flex database deployments. +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. + +Returns and adds restore jobs for flex database deployments. Options ------- @@ -49,9 +52,18 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexRestoreJobs-createFlexBackupRestoreJob` - `Public Preview: please provide feedback at `_: Restores one snapshot of one flex cluster from the specified project. -* :ref:`atlas-api-flexRestoreJobs-getFlexBackupRestoreJob` - `Public Preview: please provide feedback at `_: Returns one restore job for one flex cluster from the specified project. -* :ref:`atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs` - `Public Preview: please provide feedback at `_: Returns all restore jobs for one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-createFlexBackupRestoreJob` - 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. + +Restores one snapshot of one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-getFlexBackupRestoreJob` - 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. + +Returns one restore job for one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs` - 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. + +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 1633aff61b..1dbd89c7f7 100644 --- a/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt +++ b/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt @@ -12,7 +12,10 @@ atlas api flexSnapshots downloadFlexBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Requests one snapshot for the specified flex cluster. +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. + +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 99113cd7e1..0fce888cba 100644 --- a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt +++ b/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt @@ -12,7 +12,10 @@ atlas api flexSnapshots getFlexBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one snapshot of one flex cluster from the specified project. +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. + +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 e8a3988378..a8469347b7 100644 --- a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt +++ b/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt @@ -12,7 +12,10 @@ atlas api flexSnapshots listFlexBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all snapshots of one flex cluster from the specified project. +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. + +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 3a42b48691..06b0187fb2 100644 --- a/docs/command/atlas-api-flexSnapshots.txt +++ b/docs/command/atlas-api-flexSnapshots.txt @@ -12,7 +12,10 @@ atlas api flexSnapshots :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and requests to download flex database deployment snapshots. +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. + +Returns and requests to download flex database deployment snapshots. Options ------- @@ -49,9 +52,18 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexSnapshots-downloadFlexBackup` - `Public Preview: please provide feedback at `_: Requests one snapshot for the specified flex cluster. -* :ref:`atlas-api-flexSnapshots-getFlexBackup` - `Public Preview: please provide feedback at `_: Returns one snapshot of one flex cluster from the specified project. -* :ref:`atlas-api-flexSnapshots-listFlexBackups` - `Public Preview: please provide feedback at `_: Returns all snapshots of one flex cluster from the specified project. +* :ref:`atlas-api-flexSnapshots-downloadFlexBackup` - 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. + +Requests one snapshot for the specified flex cluster. +* :ref:`atlas-api-flexSnapshots-getFlexBackup` - 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. + +Returns one snapshot of one flex cluster from the specified project. +* :ref:`atlas-api-flexSnapshots-listFlexBackups` - 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. + +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 a508c4b35b..11148498f8 100644 --- a/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt +++ b/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt @@ -12,7 +12,10 @@ atlas api globalClusters createCustomZoneMapping :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one custom zone mapping for the specified global cluster. +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. + +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 e1be2d8115..4281e78d2c 100644 --- a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt @@ -12,7 +12,10 @@ atlas api globalClusters createManagedNamespace :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one managed namespace within the specified global cluster. +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. + +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 5bb835ef0a..9c7cbe18cd 100644 --- a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt +++ b/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt @@ -12,7 +12,10 @@ atlas api globalClusters deleteAllCustomZoneMappings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes all custom zone mappings for the specified global cluster. +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. + +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 ab23a4c2b4..4f9625dfc6 100644 --- a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt @@ -12,7 +12,10 @@ atlas api globalClusters deleteManagedNamespace :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one managed namespace within the specified global cluster. +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. + +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 e1456d8f03..d30c5bed83 100644 --- a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-getManagedNamespace.txt @@ -12,7 +12,10 @@ atlas api globalClusters getManagedNamespace :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one managed namespace within the specified global cluster. +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. + +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 d80a740f31..4ea2722e0f 100644 --- a/docs/command/atlas-api-globalClusters.txt +++ b/docs/command/atlas-api-globalClusters.txt @@ -12,7 +12,10 @@ atlas api globalClusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. +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. + +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. @@ -52,11 +55,26 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-globalClusters-createCustomZoneMapping` - `Public Preview: please provide feedback at `_: Creates one custom zone mapping for the specified global cluster. -* :ref:`atlas-api-globalClusters-createManagedNamespace` - `Public Preview: please provide feedback at `_: Creates one managed namespace within the specified global cluster. -* :ref:`atlas-api-globalClusters-deleteAllCustomZoneMappings` - `Public Preview: please provide feedback at `_: Removes all custom zone mappings for the specified global cluster. -* :ref:`atlas-api-globalClusters-deleteManagedNamespace` - `Public Preview: please provide feedback at `_: Removes one managed namespace within the specified global cluster. -* :ref:`atlas-api-globalClusters-getManagedNamespace` - `Public Preview: please provide feedback at `_: Returns one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-createCustomZoneMapping` - 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. + +Creates one custom zone mapping for the specified global cluster. +* :ref:`atlas-api-globalClusters-createManagedNamespace` - 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. + +Creates one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-deleteAllCustomZoneMappings` - 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. + +Removes all custom zone mappings for the specified global cluster. +* :ref:`atlas-api-globalClusters-deleteManagedNamespace` - 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. + +Removes one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-getManagedNamespace` - 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. + +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 59ca1c05e2..d94910cda9 100644 --- a/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt +++ b/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt @@ -12,7 +12,10 @@ atlas api invoices createCostExplorerQueryProcess :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates a query process within the Cost Explorer for the given parameters. +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. + +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 00c503d530..a840640ed1 100644 --- a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt +++ b/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt @@ -12,7 +12,10 @@ atlas api invoices downloadInvoiceCsv :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one invoice that MongoDB issued to the specified organization in CSV format. +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. + +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 1278f60aff..2dd16fab54 100644 --- a/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt +++ b/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt @@ -12,7 +12,10 @@ atlas api invoices getCostExplorerQueryProcess :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. +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. + +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 b09dbe63f6..442d2dbead 100644 --- a/docs/command/atlas-api-invoices-getInvoice.txt +++ b/docs/command/atlas-api-invoices-getInvoice.txt @@ -12,7 +12,10 @@ atlas api invoices getInvoice :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one invoice that MongoDB issued to the specified organization. +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. + +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 df897cdb9a..60a393b261 100644 --- a/docs/command/atlas-api-invoices-listInvoices.txt +++ b/docs/command/atlas-api-invoices-listInvoices.txt @@ -12,7 +12,10 @@ atlas api invoices listInvoices :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all invoices that MongoDB issued to the specified organization. +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. + +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 9e67c8c068..615975d391 100644 --- a/docs/command/atlas-api-invoices-listPendingInvoices.txt +++ b/docs/command/atlas-api-invoices-listPendingInvoices.txt @@ -12,7 +12,10 @@ atlas api invoices listPendingInvoices :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all invoices accruing charges for the current billing cycle for the specified organization. +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. + +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 df0acf3253..6a11ab65c9 100644 --- a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt +++ b/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt @@ -12,7 +12,10 @@ atlas api invoices queryLineItemsFromSingleInvoice :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Query the lineItems of the specified invoice and return the result JSON. +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. + +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 9187866ae9..576dae9d70 100644 --- a/docs/command/atlas-api-invoices.txt +++ b/docs/command/atlas-api-invoices.txt @@ -12,7 +12,10 @@ atlas api invoices :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns invoices. +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. + +Returns invoices. Options ------- @@ -49,13 +52,34 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-invoices-createCostExplorerQueryProcess` - `Public Preview: please provide feedback at `_: Creates a query process within the Cost Explorer for the given parameters. -* :ref:`atlas-api-invoices-downloadInvoiceCsv` - `Public Preview: please provide feedback at `_: Returns one invoice that MongoDB issued to the specified organization in CSV format. -* :ref:`atlas-api-invoices-getCostExplorerQueryProcess` - `Public Preview: please provide feedback at `_: 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 at `_: Returns one invoice that MongoDB issued to the specified organization. -* :ref:`atlas-api-invoices-listInvoices` - `Public Preview: please provide feedback at `_: Returns all invoices that MongoDB issued to the specified organization. -* :ref:`atlas-api-invoices-listPendingInvoices` - `Public Preview: please provide feedback at `_: Returns all invoices accruing charges for the current billing cycle for the specified organization. -* :ref:`atlas-api-invoices-queryLineItemsFromSingleInvoice` - `Public Preview: please provide feedback at `_: Query the lineItems of the specified invoice and return the result JSON. +* :ref:`atlas-api-invoices-createCostExplorerQueryProcess` - 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. + +Creates a query process within the Cost Explorer for the given parameters. +* :ref:`atlas-api-invoices-downloadInvoiceCsv` - 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. + +Returns one invoice that MongoDB issued to the specified organization in CSV format. +* :ref:`atlas-api-invoices-getCostExplorerQueryProcess` - 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. + +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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +* :ref:`atlas-api-invoices-listInvoices` - 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. + +Returns all invoices that MongoDB issued to the specified organization. +* :ref:`atlas-api-invoices-listPendingInvoices` - 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. + +Returns all invoices accruing charges for the current billing cycle for the specified organization. +* :ref:`atlas-api-invoices-queryLineItemsFromSingleInvoice` - 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. + +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 36cdcbeb40..bd8d8a3857 100644 --- a/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt @@ -12,7 +12,10 @@ atlas api ldapConfiguration deleteLdapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. +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. + +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 801400baa4..1a9d5d0d32 100644 --- a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt @@ -12,7 +12,10 @@ atlas api ldapConfiguration getLdapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the current LDAP configuration for the specified project. +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. + +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 d23cddf840..d6d8a8872a 100644 --- a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt +++ b/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt @@ -12,7 +12,10 @@ atlas api ldapConfiguration getLdapConfigurationStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the status of one request to verify one LDAP configuration for the specified project. +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. + +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 c4a0c9b024..330e0591e9 100644 --- a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt @@ -12,7 +12,10 @@ atlas api ldapConfiguration saveLdapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Edits the LDAP configuration for the specified project. +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. + +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 df010c815e..31969cd6bf 100644 --- a/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt @@ -12,7 +12,10 @@ atlas api ldapConfiguration verifyLdapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Verifies the LDAP configuration for the specified project. +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. + +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 d8232a70cf..734f4cf87e 100644 --- a/docs/command/atlas-api-ldapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration.txt @@ -12,7 +12,10 @@ atlas api ldapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, edits, verifies, and removes LDAP configurations. +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. + +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. @@ -51,11 +54,26 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-ldapConfiguration-deleteLdapConfiguration` - `Public Preview: please provide feedback at `_: 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 at `_: Returns the current LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-getLdapConfigurationStatus` - `Public Preview: please provide feedback at `_: 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 at `_: Edits the LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-verifyLdapConfiguration` - `Public Preview: please provide feedback at `_: Verifies the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-deleteLdapConfiguration` - 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. + +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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +* :ref:`atlas-api-ldapConfiguration-getLdapConfigurationStatus` - 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. + +Returns the status of one request to verify one LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-saveLdapConfiguration` - 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. + +Edits the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-verifyLdapConfiguration` - 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. + +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 9dfe382cfe..9a2d18a434 100644 --- a/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt +++ b/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt @@ -12,7 +12,10 @@ atlas api legacyBackup createLegacyBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Restores one legacy backup for one cluster in the specified project. +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. + +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 2531662914..43eb819fe9 100644 --- a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt +++ b/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt @@ -12,7 +12,10 @@ atlas api legacyBackup deleteLegacySnapshot :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one legacy backup snapshot for one cluster in the specified project. +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. + +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 5d3cece2f4..0029b5e62d 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt @@ -12,7 +12,10 @@ atlas api legacyBackup getLegacyBackupCheckpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one legacy backup checkpoint for one cluster in the specified project. +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. + +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 f3916a4fdf..a5fffe6752 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt @@ -12,7 +12,10 @@ atlas api legacyBackup getLegacyBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one legacy backup restore job for one cluster in the specified project. +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. + +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 bc9ba95dee..88eb8090ea 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt @@ -12,7 +12,10 @@ atlas api legacyBackup getLegacySnapshot :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one legacy backup snapshot for one cluster in the specified project. +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. + +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 fdb95a4b85..0c20e097da 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt @@ -12,7 +12,10 @@ atlas api legacyBackup getLegacySnapshotSchedule :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the snapshot schedule for one cluster in the specified project. +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. + +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 e217d3cc49..841ed36403 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt @@ -12,7 +12,10 @@ atlas api legacyBackup listLegacyBackupCheckpoints :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all legacy backup checkpoints for one cluster in the specified project. +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. + +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 d029703fc4..25d708c314 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt @@ -12,7 +12,10 @@ atlas api legacyBackup listLegacyBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all legacy backup restore jobs for one cluster in the specified project. +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. + +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 95c69bd3f9..3ca3951db6 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt @@ -12,7 +12,10 @@ atlas api legacyBackup listLegacySnapshots :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all legacy backup snapshots for one cluster in the specified project. +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. + +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 41032f4405..185aed99ef 100644 --- a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt +++ b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt @@ -12,7 +12,10 @@ atlas api legacyBackup updateLegacySnapshotRetention :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. +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. + +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 d176377f47..65f1e67656 100644 --- a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt +++ b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt @@ -12,7 +12,10 @@ atlas api legacyBackup updateLegacySnapshotSchedule :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the snapshot schedule for one cluster in the specified project. +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. + +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 51c7621381..78253edd48 100644 --- a/docs/command/atlas-api-legacyBackup.txt +++ b/docs/command/atlas-api-legacyBackup.txt @@ -12,7 +12,10 @@ atlas api legacyBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. +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. + +Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. Options ------- @@ -49,17 +52,50 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-legacyBackup-createLegacyBackupRestoreJob` - `Public Preview: please provide feedback at `_: Restores one legacy backup for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-deleteLegacySnapshot` - `Public Preview: please provide feedback at `_: Removes one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacyBackupCheckpoint` - `Public Preview: please provide feedback at `_: Returns one legacy backup checkpoint for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacyBackupRestoreJob` - `Public Preview: please provide feedback at `_: Returns one legacy backup restore job for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacySnapshot` - `Public Preview: please provide feedback at `_: Returns one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacySnapshotSchedule` - `Public Preview: please provide feedback at `_: Returns the snapshot schedule for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacyBackupCheckpoints` - `Public Preview: please provide feedback at `_: Returns all legacy backup checkpoints for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacyBackupRestoreJobs` - `Public Preview: please provide feedback at `_: Returns all legacy backup restore jobs for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacySnapshots` - `Public Preview: please provide feedback at `_: Returns all legacy backup snapshots for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-updateLegacySnapshotRetention` - `Public Preview: please provide feedback at `_: 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 at `_: Updates the snapshot schedule for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-createLegacyBackupRestoreJob` - 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. + +Restores one legacy backup for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-deleteLegacySnapshot` - 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. + +Removes one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacyBackupCheckpoint` - 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. + +Returns one legacy backup checkpoint for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacyBackupRestoreJob` - 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. + +Returns one legacy backup restore job for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacySnapshot` - 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. + +Returns one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacySnapshotSchedule` - 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. + +Returns the snapshot schedule for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacyBackupCheckpoints` - 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. + +Returns all legacy backup checkpoints for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacyBackupRestoreJobs` - 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. + +Returns all legacy backup restore jobs for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacySnapshots` - 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. + +Returns all legacy backup snapshots for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-updateLegacySnapshotRetention` - 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. + +Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-updateLegacySnapshotSchedule` - 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. + +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 897e67be9e..0aad9d25f6 100644 --- a/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt @@ -12,7 +12,10 @@ atlas api maintenanceWindows deferMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Defers the maintenance window for the specified project. +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. + +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 0c0862c49f..aa29e38438 100644 --- a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt @@ -12,7 +12,10 @@ atlas api maintenanceWindows getMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the maintenance window for the specified project. +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. + +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 202b6e38be..7947c60b7a 100644 --- a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt @@ -12,7 +12,10 @@ atlas api maintenanceWindows resetMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Resets the maintenance window for the specified project. +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. + +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 8332c83056..b72426c075 100644 --- a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt +++ b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt @@ -12,7 +12,10 @@ atlas api maintenanceWindows toggleMaintenanceAutoDefer :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Toggles automatic deferral of the maintenance window for the specified project. +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. + +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 0d58a227cb..a5db2a25cb 100644 --- a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt @@ -12,7 +12,10 @@ atlas api maintenanceWindows updateMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the maintenance window for the specified project. +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. + +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 f9afbf26df..739f5be107 100644 --- a/docs/command/atlas-api-maintenanceWindows.txt +++ b/docs/command/atlas-api-maintenanceWindows.txt @@ -12,7 +12,10 @@ atlas api maintenanceWindows :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, edits, and removes maintenance windows. +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. + +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. @@ -51,11 +54,26 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-maintenanceWindows-deferMaintenanceWindow` - `Public Preview: please provide feedback at `_: Defers the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-getMaintenanceWindow` - `Public Preview: please provide feedback at `_: Returns the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-resetMaintenanceWindow` - `Public Preview: please provide feedback at `_: Resets the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer` - `Public Preview: please provide feedback at `_: Toggles automatic deferral of the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-updateMaintenanceWindow` - `Public Preview: please provide feedback at `_: Updates the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-deferMaintenanceWindow` - 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. + +Defers the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-getMaintenanceWindow` - 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. + +Returns the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-resetMaintenanceWindow` - 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. + +Resets the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer` - 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. + +Toggles automatic deferral of the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-updateMaintenanceWindow` - 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. + +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 ae5212353d..bd438c707f 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers addOrganizationRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one organization-level role to the MongoDB Cloud user. +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. + +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 26ee0230fd..e26109ba9d 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers addProjectRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one project-level role to the MongoDB Cloud user. +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. + +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 b5ce6cfeea..e5a1de48ea 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers addProjectUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to one project. +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. + +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 8787e6c1e3..b958c4609e 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers addUserToTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to one team. +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. + +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 b6a3d167b9..303600b953 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers createOrganizationUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Invites one new or existing MongoDB Cloud user to join the organization. +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. + +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 3b69db07ee..5615dcc694 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers createUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one MongoDB Cloud user account. +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. + +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 3f828cae34..fdf3ff2324 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers getOrganizationUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns information about the specified MongoDB Cloud user within the context of the specified organization. +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. + +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 c2de3249c4..400b6515c1 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers getProjectUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns information about the specified MongoDB Cloud user within the context of the specified project. +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. + +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 a0709c0938..cc706d3caf 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers getUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. +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. + +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 cbbf435e72..1217621ce2 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers getUserByUsername :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details for one MongoDB Cloud user account with the specified username. +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. + +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 ea1b75e333..b1400eb6eb 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers listOrganizationUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the pending and active MongoDB Cloud users associated with the specified organization. +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. + +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 b26c54709d..f2a91603df 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers listProjectUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the pending and active MongoDB Cloud users associated with the specified project. +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. + +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 65538702a3..3b764f2c83 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers listTeamUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. +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. + +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 362f9eec2f..dc6e5fdd17 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers removeOrganizationRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one organization-level role from the MongoDB Cloud user. +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. + +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 e83dad6eb7..8303b59180 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers removeOrganizationUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user in the specified organization. +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. + +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 235ef957e7..9fc66357cf 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers removeProjectRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one project-level role from the MongoDB Cloud user. +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. + +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 5bef83a8f2..e6f362ac27 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers removeProjectUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from the specified project. +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. + +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 cb1d8ca618..9a23519417 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers removeUserFromTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from one team. +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. + +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 748cfd7566..4372df8578 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers updateOrganizationUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one MongoDB Cloud user in the specified organization. +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. + +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 1d60ef212d..979b38cf0e 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers.txt @@ -12,7 +12,10 @@ atlas api mongoDbCloudUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, and edits MongoDB Cloud users. +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. + +Returns, adds, and edits MongoDB Cloud users. Options ------- @@ -49,25 +52,82 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-mongoDbCloudUsers-addOrganizationRole` - `Public Preview: please provide feedback at `_: Adds one organization-level role to the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-addProjectRole` - `Public Preview: please provide feedback at `_: Adds one project-level role to the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-addProjectUser` - `Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to one project. -* :ref:`atlas-api-mongoDbCloudUsers-addUserToTeam` - `Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to one team. -* :ref:`atlas-api-mongoDbCloudUsers-createOrganizationUser` - `Public Preview: please provide feedback at `_: Invites one new or existing MongoDB Cloud user to join the organization. -* :ref:`atlas-api-mongoDbCloudUsers-createUser` - `Public Preview: please provide feedback at `_: Creates one MongoDB Cloud user account. -* :ref:`atlas-api-mongoDbCloudUsers-getOrganizationUser` - `Public Preview: please provide feedback at `_: 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 at `_: 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 at `_: 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 at `_: Returns the details for one MongoDB Cloud user account with the specified username. -* :ref:`atlas-api-mongoDbCloudUsers-listOrganizationUsers` - `Public Preview: please provide feedback at `_: 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 at `_: 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 at `_: 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 at `_: Removes one organization-level role from the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationUser` - `Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user in the specified organization. -* :ref:`atlas-api-mongoDbCloudUsers-removeProjectRole` - `Public Preview: please provide feedback at `_: Removes one project-level role from the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-removeProjectUser` - `Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from the specified project. -* :ref:`atlas-api-mongoDbCloudUsers-removeUserFromTeam` - `Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from one team. -* :ref:`atlas-api-mongoDbCloudUsers-updateOrganizationUser` - `Public Preview: please provide feedback at `_: Updates one MongoDB Cloud user in the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-addOrganizationRole` - 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. + +Adds one organization-level role to the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-addProjectRole` - 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. + +Adds one project-level role to the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-addProjectUser` - 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. + +Adds one MongoDB Cloud user to one project. +* :ref:`atlas-api-mongoDbCloudUsers-addUserToTeam` - 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. + +Adds one MongoDB Cloud user to one team. +* :ref:`atlas-api-mongoDbCloudUsers-createOrganizationUser` - 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. + +Invites one new or existing MongoDB Cloud user to join the organization. +* :ref:`atlas-api-mongoDbCloudUsers-createUser` - 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. + +Creates one MongoDB Cloud user account. +* :ref:`atlas-api-mongoDbCloudUsers-getOrganizationUser` - 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. + +Returns information about the specified MongoDB Cloud user within the context of the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-getProjectUser` - 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. + +Returns information about the specified MongoDB Cloud user within the context of the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-getUser` - 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. + +Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. +* :ref:`atlas-api-mongoDbCloudUsers-getUserByUsername` - 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. + +Returns the details for one MongoDB Cloud user account with the specified username. +* :ref:`atlas-api-mongoDbCloudUsers-listOrganizationUsers` - 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. + +Returns details about the pending and active MongoDB Cloud users associated with the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-listProjectUsers` - 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. + +Returns details about the pending and active MongoDB Cloud users associated with the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-listTeamUsers` - 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. + +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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationUser` - 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. + +Removes one MongoDB Cloud user in the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-removeProjectRole` - 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. + +Removes one project-level role from the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-removeProjectUser` - 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. + +Removes one MongoDB Cloud user from the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-removeUserFromTeam` - 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. + +Removes one MongoDB Cloud user from one team. +* :ref:`atlas-api-mongoDbCloudUsers-updateOrganizationUser` - 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. + +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 30ed532e5c..2f227ab705 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt @@ -12,7 +12,10 @@ atlas api monitoringAndLogs getAtlasProcess :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the processes for the specified host for the specified project. +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. + +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 ebf8ade1e6..2dd0c280a3 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt @@ -12,7 +12,10 @@ atlas api monitoringAndLogs getDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one database running on the specified host for the specified project. +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. + +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 cc743bc88e..547396fcf2 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt @@ -12,7 +12,10 @@ atlas api monitoringAndLogs getDatabaseMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the measurements of one database for the specified host for the specified project. +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. + +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 84a65f048f..f5f95c5110 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt @@ -12,7 +12,10 @@ atlas api monitoringAndLogs getDiskMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the measurements of one disk or partition for the specified host for the specified project. +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. + +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 a0d76eeb1f..0780036452 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt @@ -12,7 +12,10 @@ atlas api monitoringAndLogs getHostLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. +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. + +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 2769fe8f73..a279c489ad 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt @@ -12,7 +12,10 @@ atlas api monitoringAndLogs getHostMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns disk, partition, or host measurements per process for the specified host for the specified project. +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. + +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 460216cde9..88dbc5a318 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt @@ -12,7 +12,10 @@ atlas api monitoringAndLogs getIndexMetrics :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. +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. + +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 c9c9e13e3b..72d2650dff 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt @@ -12,7 +12,10 @@ atlas api monitoringAndLogs getMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. +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. + +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 8c4de1d535..6f30ae2de1 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt @@ -12,7 +12,10 @@ atlas api monitoringAndLogs listAtlasProcesses :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details of all processes for the specified project. +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. + +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 86e82bb4c4..1b453d626a 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt @@ -12,7 +12,10 @@ atlas api monitoringAndLogs listDatabases :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the list of databases running on the specified host for the specified project. +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. + +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 5d14b35be7..a5685c25fe 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt @@ -12,7 +12,10 @@ atlas api monitoringAndLogs listDiskMeasurements :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns measurement details for one disk or partition for the specified host for the specified project. +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. + +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 3522f4d942..3367229401 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt @@ -12,7 +12,10 @@ atlas api monitoringAndLogs listDiskPartitions :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the list of disks or partitions for the specified host for the specified project. +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. + +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 e0d72757bc..5dabb6e29e 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt @@ -12,7 +12,10 @@ atlas api monitoringAndLogs listIndexMetrics :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listIndexMetrics. diff --git a/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt b/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt index 0973a15417..0812666e25 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt @@ -12,7 +12,10 @@ atlas api monitoringAndLogs listMetricTypes :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Atlas Search metric types available for one process in the specified project. +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. + +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 6a57195777..28d77fb594 100644 --- a/docs/command/atlas-api-monitoringAndLogs.txt +++ b/docs/command/atlas-api-monitoringAndLogs.txt @@ -12,7 +12,10 @@ atlas api monitoringAndLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns database deployment monitoring and logging data. +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. + +Returns database deployment monitoring and logging data. Options ------- @@ -49,20 +52,62 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-monitoringAndLogs-getAtlasProcess` - `Public Preview: please provide feedback at `_: Returns the processes for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDatabase` - `Public Preview: please provide feedback at `_: Returns one database running on the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDatabaseMeasurements` - `Public Preview: please provide feedback at `_: Returns the measurements of one database for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDiskMeasurements` - `Public Preview: please provide feedback at `_: 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 at `_: 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 at `_: 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 at `_: 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 at `_: 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 at `_: Returns details of all processes for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDatabases` - `Public Preview: please provide feedback at `_: Returns the list of databases running on the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDiskMeasurements` - `Public Preview: please provide feedback at `_: 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 at `_: 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 at `_: 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 at `_: Returns all Atlas Search metric types available for one process in the specified project. +* :ref:`atlas-api-monitoringAndLogs-getAtlasProcess` - 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. + +Returns the processes for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDatabase` - 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. + +Returns one database running on the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDatabaseMeasurements` - 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. + +Returns the measurements of one database for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDiskMeasurements` - 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. + +Returns the measurements of one disk or partition for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getHostLogs` - 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. + +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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +* :ref:`atlas-api-monitoringAndLogs-getIndexMetrics` - 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. + +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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +* :ref:`atlas-api-monitoringAndLogs-listAtlasProcesses` - 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. + +Returns details of all processes for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDatabases` - 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. + +Returns the list of databases running on the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDiskMeasurements` - 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. + +Returns measurement details for one disk or partition for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDiskPartitions` - 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. + +Returns the list of disks or partitions for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listIndexMetrics` - 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. + +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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. .. toctree:: diff --git a/docs/command/atlas-api-networkPeering-createPeeringConnection.txt b/docs/command/atlas-api-networkPeering-createPeeringConnection.txt index 30cc694330..bc9fa37014 100644 --- a/docs/command/atlas-api-networkPeering-createPeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-createPeeringConnection.txt @@ -12,7 +12,10 @@ atlas api networkPeering createPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one new network peering connection in the specified project. +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. + +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 807f2a1535..e9f825d485 100644 --- a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-createPeeringContainer.txt @@ -12,7 +12,10 @@ atlas api networkPeering createPeeringContainer :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one new network peering container in the specified project. +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. + +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 e6b12b1e60..6f404a1d64 100644 --- a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt @@ -12,7 +12,10 @@ atlas api networkPeering deletePeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one network peering connection in the specified project. +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. + +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 1a78a44fd2..a1e880a4dd 100644 --- a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt @@ -12,7 +12,10 @@ atlas api networkPeering deletePeeringContainer :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one network peering container in the specified project. +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. + +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 e05189cf5f..76c1203de9 100644 --- a/docs/command/atlas-api-networkPeering-disablePeering.txt +++ b/docs/command/atlas-api-networkPeering-disablePeering.txt @@ -12,7 +12,10 @@ atlas api networkPeering disablePeering :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Disables Connect via Peering Only mode for the specified project. +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. + +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 e97cd1f5d8..5fd19724d8 100644 --- a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-getPeeringConnection.txt @@ -12,7 +12,10 @@ atlas api networkPeering getPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about one specified network peering connection in the specified project. +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. + +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 b0cb542866..4003724e82 100644 --- a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-getPeeringContainer.txt @@ -12,7 +12,10 @@ atlas api networkPeering getPeeringContainer :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about one network peering container in one specified project. +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. + +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 89df6dda6e..3cb596b050 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringConnections.txt @@ -12,7 +12,10 @@ atlas api networkPeering listPeeringConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about all network peering connections in the specified project. +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. + +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 9c1493220e..a3a1259e3d 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt @@ -12,7 +12,10 @@ atlas api networkPeering listPeeringContainerByCloudProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about all network peering containers in the specified project for the specified cloud provider. +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. + +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 6ba5038007..7a6ba3406b 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringContainers.txt @@ -12,7 +12,10 @@ atlas api networkPeering listPeeringContainers :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about all network peering containers in the specified project. +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. + +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 52d2e84d3e..42def7623e 100644 --- a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt @@ -12,7 +12,10 @@ atlas api networkPeering updatePeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one specified network peering connection in the specified project. +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. + +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 2dba9e2eb6..06185af7ff 100644 --- a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt @@ -12,7 +12,10 @@ atlas api networkPeering updatePeeringContainer :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the network details and labels of one specified network peering container in the specified project. +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. + +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 ade58baa6d..a899ac7f1d 100644 --- a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt +++ b/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt @@ -12,7 +12,10 @@ atlas api networkPeering verifyConnectViaPeeringOnlyModeForOneProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Verifies if someone set the specified project to Connect via Peering Only mode. +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. + +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 2654e29ed4..3e64aad3a1 100644 --- a/docs/command/atlas-api-networkPeering.txt +++ b/docs/command/atlas-api-networkPeering.txt @@ -12,7 +12,10 @@ atlas api networkPeering :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes network peering containers and peering connections. +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. + +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. @@ -51,19 +54,58 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-networkPeering-createPeeringConnection` - `Public Preview: please provide feedback at `_: Creates one new network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-createPeeringContainer` - `Public Preview: please provide feedback at `_: Creates one new network peering container in the specified project. -* :ref:`atlas-api-networkPeering-deletePeeringConnection` - `Public Preview: please provide feedback at `_: Removes one network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-deletePeeringContainer` - `Public Preview: please provide feedback at `_: Removes one network peering container in the specified project. -* :ref:`atlas-api-networkPeering-disablePeering` - `Public Preview: please provide feedback at `_: Disables Connect via Peering Only mode for the specified project. -* :ref:`atlas-api-networkPeering-getPeeringConnection` - `Public Preview: please provide feedback at `_: Returns details about one specified network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-getPeeringContainer` - `Public Preview: please provide feedback at `_: Returns details about one network peering container in one specified project. -* :ref:`atlas-api-networkPeering-listPeeringConnections` - `Public Preview: please provide feedback at `_: Returns details about all network peering connections in the specified project. -* :ref:`atlas-api-networkPeering-listPeeringContainerByCloudProvider` - `Public Preview: please provide feedback at `_: 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 at `_: Returns details about all network peering containers in the specified project. -* :ref:`atlas-api-networkPeering-updatePeeringConnection` - `Public Preview: please provide feedback at `_: Updates one specified network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-updatePeeringContainer` - `Public Preview: please provide feedback at `_: 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 at `_: Verifies if someone set the specified project to Connect via Peering Only mode. +* :ref:`atlas-api-networkPeering-createPeeringConnection` - 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. + +Creates one new network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-createPeeringContainer` - 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. + +Creates one new network peering container in the specified project. +* :ref:`atlas-api-networkPeering-deletePeeringConnection` - 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. + +Removes one network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-deletePeeringContainer` - 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. + +Removes one network peering container in the specified project. +* :ref:`atlas-api-networkPeering-disablePeering` - 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. + +Disables Connect via Peering Only mode for the specified project. +* :ref:`atlas-api-networkPeering-getPeeringConnection` - 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. + +Returns details about one specified network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-getPeeringContainer` - 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. + +Returns details about one network peering container in one specified project. +* :ref:`atlas-api-networkPeering-listPeeringConnections` - 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. + +Returns details about all network peering connections in the specified project. +* :ref:`atlas-api-networkPeering-listPeeringContainerByCloudProvider` - 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. + +Returns details about all network peering containers in the specified project for the specified cloud provider. +* :ref:`atlas-api-networkPeering-listPeeringContainers` - 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. + +Returns details about all network peering containers in the specified project. +* :ref:`atlas-api-networkPeering-updatePeeringConnection` - 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. + +Updates one specified network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-updatePeeringContainer` - 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. + +Updates the network details and labels of one specified network peering container in the specified project. +* :ref:`atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject` - 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. + +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 c960cb79da..533c5c6949 100644 --- a/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt @@ -12,7 +12,10 @@ atlas api onlineArchive createOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one online archive. +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. + +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 49ba3d9665..3e58ec09a7 100644 --- a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt @@ -12,7 +12,10 @@ atlas api onlineArchive deleteOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one online archive. +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. + +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 90a17303a4..f4ae6dde7e 100644 --- a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt +++ b/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt @@ -12,7 +12,10 @@ atlas api onlineArchive downloadOnlineArchiveQueryLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Downloads query logs for the specified online archive. +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. + +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 c79acac08b..5f2cf4a5fd 100644 --- a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt @@ -12,7 +12,10 @@ atlas api onlineArchive getOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one online archive for one cluster. +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. + +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 c8f67f6107..885ad26e17 100644 --- a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt +++ b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt @@ -12,7 +12,10 @@ atlas api onlineArchive listOnlineArchives :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details of all online archives. +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. + +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 207d4d5b34..fef015e41c 100644 --- a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt @@ -12,7 +12,10 @@ atlas api onlineArchive updateOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates, pauses, or resumes one online archive. +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. + +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 2898a1397a..cb7b9e5e7d 100644 --- a/docs/command/atlas-api-onlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive.txt @@ -12,7 +12,10 @@ atlas api onlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, or removes an online archive. +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. + +Returns, adds, edits, or removes an online archive. Options ------- @@ -49,12 +52,30 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-onlineArchive-createOnlineArchive` - `Public Preview: please provide feedback at `_: Creates one online archive. -* :ref:`atlas-api-onlineArchive-deleteOnlineArchive` - `Public Preview: please provide feedback at `_: Removes one online archive. -* :ref:`atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs` - `Public Preview: please provide feedback at `_: Downloads query logs for the specified online archive. -* :ref:`atlas-api-onlineArchive-getOnlineArchive` - `Public Preview: please provide feedback at `_: Returns one online archive for one cluster. -* :ref:`atlas-api-onlineArchive-listOnlineArchives` - `Public Preview: please provide feedback at `_: Returns details of all online archives. -* :ref:`atlas-api-onlineArchive-updateOnlineArchive` - `Public Preview: please provide feedback at `_: Updates, pauses, or resumes one online archive. +* :ref:`atlas-api-onlineArchive-createOnlineArchive` - 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. + +Creates one online archive. +* :ref:`atlas-api-onlineArchive-deleteOnlineArchive` - 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. + +Removes one online archive. +* :ref:`atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs` - 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. + +Downloads query logs for the specified online archive. +* :ref:`atlas-api-onlineArchive-getOnlineArchive` - 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. + +Returns one online archive for one cluster. +* :ref:`atlas-api-onlineArchive-listOnlineArchives` - 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. + +Returns details of all online archives. +* :ref:`atlas-api-onlineArchive-updateOnlineArchive` - 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. + +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 2609e76e8b..711c3bfdf6 100644 --- a/docs/command/atlas-api-organizations-createOrganization.txt +++ b/docs/command/atlas-api-organizations-createOrganization.txt @@ -12,7 +12,10 @@ atlas api organizations createOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. +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. + +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 32c2ce9f57..5f4445b49b 100644 --- a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-createOrganizationInvitation.txt @@ -12,7 +12,10 @@ atlas api organizations createOrganizationInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Invites one MongoDB Cloud user to join the specified organization. +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. + +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 52c8ed35eb..2c0496ec02 100644 --- a/docs/command/atlas-api-organizations-deleteOrganization.txt +++ b/docs/command/atlas-api-organizations-deleteOrganization.txt @@ -12,7 +12,10 @@ atlas api organizations deleteOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one specified organization. +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. + +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 47adb79a58..71231db074 100644 --- a/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt @@ -12,7 +12,10 @@ atlas api organizations deleteOrganizationInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. +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. + +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 3ea34a8543..c081358817 100644 --- a/docs/command/atlas-api-organizations-getOrganization.txt +++ b/docs/command/atlas-api-organizations-getOrganization.txt @@ -12,7 +12,10 @@ atlas api organizations getOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one organization to which the requesting Service Account or API Key has 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. + +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 3c2ff14113..77c5045b0d 100644 --- a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-getOrganizationInvitation.txt @@ -12,7 +12,10 @@ atlas api organizations getOrganizationInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one pending invitation to the specified organization. +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. + +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 46fba4d63b..dc7a7784b7 100644 --- a/docs/command/atlas-api-organizations-getOrganizationSettings.txt +++ b/docs/command/atlas-api-organizations-getOrganizationSettings.txt @@ -12,7 +12,10 @@ atlas api organizations getOrganizationSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the specified organization's settings. +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. + +Returns details about the specified 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-listOrganizationInvitations.txt b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt index 3266b49da8..756ba3fc0a 100644 --- a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt +++ b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt @@ -12,7 +12,10 @@ atlas api organizations listOrganizationInvitations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all pending invitations to the specified organization. +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. + +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 bdb8f5a618..3277ef45fa 100644 --- a/docs/command/atlas-api-organizations-listOrganizationProjects.txt +++ b/docs/command/atlas-api-organizations-listOrganizationProjects.txt @@ -12,7 +12,10 @@ atlas api organizations listOrganizationProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns multiple projects in the specified organization. +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. + +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 262cd9cd1b..b076a74eda 100644 --- a/docs/command/atlas-api-organizations-listOrganizations.txt +++ b/docs/command/atlas-api-organizations-listOrganizations.txt @@ -12,7 +12,10 @@ atlas api organizations listOrganizations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all organizations to which the requesting Service Account or API Key has 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. + +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 4870d1834a..ecd7b3ff01 100644 --- a/docs/command/atlas-api-organizations-updateOrganization.txt +++ b/docs/command/atlas-api-organizations-updateOrganization.txt @@ -12,7 +12,10 @@ atlas api organizations updateOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one organization. +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. + +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 91a30220d4..572ab9b14e 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt @@ -12,7 +12,10 @@ atlas api organizations updateOrganizationInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. +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. + +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 4ffe789397..088e32e16c 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt @@ -12,7 +12,10 @@ atlas api organizations updateOrganizationInvitationById :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by its unique ID, to the specified organization. +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. + +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 93b98fd20b..4e8ca8af8c 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationRoles.txt @@ -12,7 +12,10 @@ atlas api organizations updateOrganizationRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the roles of the specified user in the specified organization. +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. + +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 b89db7c3c4..524137555f 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationSettings.txt @@ -12,7 +12,10 @@ atlas api organizations updateOrganizationSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the organization's settings. +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. + +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 8d12bcb694..8ee879dd6b 100644 --- a/docs/command/atlas-api-organizations.txt +++ b/docs/command/atlas-api-organizations.txt @@ -12,7 +12,10 @@ atlas api organizations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, and edits organizational units in MongoDB Cloud. +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. + +Returns, adds, and edits organizational units in MongoDB Cloud. Options ------- @@ -49,21 +52,66 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-organizations-createOrganization` - `Public Preview: please provide feedback at `_: 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 at `_: Invites one MongoDB Cloud user to join the specified organization. -* :ref:`atlas-api-organizations-deleteOrganization` - `Public Preview: please provide feedback at `_: Removes one specified organization. -* :ref:`atlas-api-organizations-deleteOrganizationInvitation` - `Public Preview: please provide feedback at `_: 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 at `_: Returns one organization to which the requesting Service Account or API Key has access. -* :ref:`atlas-api-organizations-getOrganizationInvitation` - `Public Preview: please provide feedback at `_: Returns the details of one pending invitation to the specified organization. -* :ref:`atlas-api-organizations-getOrganizationSettings` - `Public Preview: please provide feedback at `_: Returns details about the specified organization's settings. -* :ref:`atlas-api-organizations-listOrganizationInvitations` - `Public Preview: please provide feedback at `_: Returns all pending invitations to the specified organization. -* :ref:`atlas-api-organizations-listOrganizationProjects` - `Public Preview: please provide feedback at `_: Returns multiple projects in the specified organization. -* :ref:`atlas-api-organizations-listOrganizations` - `Public Preview: please provide feedback at `_: Returns all organizations to which the requesting Service Account or API Key has access. -* :ref:`atlas-api-organizations-updateOrganization` - `Public Preview: please provide feedback at `_: Updates one organization. -* :ref:`atlas-api-organizations-updateOrganizationInvitation` - `Public Preview: please provide feedback at `_: 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 at `_: 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 at `_: Updates the roles of the specified user in the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationSettings` - `Public Preview: please provide feedback at `_: Updates the organization's settings. +* :ref:`atlas-api-organizations-createOrganization` - 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. + +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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +* :ref:`atlas-api-organizations-deleteOrganization` - 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. + +Removes one specified organization. +* :ref:`atlas-api-organizations-deleteOrganizationInvitation` - 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. + +Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. +* :ref:`atlas-api-organizations-getOrganization` - 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. + +Returns one organization to which the requesting Service Account or API Key has access. +* :ref:`atlas-api-organizations-getOrganizationInvitation` - 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. + +Returns the details of one pending invitation to the specified organization. +* :ref:`atlas-api-organizations-getOrganizationSettings` - 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. + +Returns details about the specified organization's settings. +* :ref:`atlas-api-organizations-listOrganizationInvitations` - 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. + +Returns all pending invitations to the specified organization. +* :ref:`atlas-api-organizations-listOrganizationProjects` - 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. + +Returns multiple projects in the specified organization. +* :ref:`atlas-api-organizations-listOrganizations` - 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. + +Returns all organizations to which the requesting Service Account or API Key has access. +* :ref:`atlas-api-organizations-updateOrganization` - 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. + +Updates one organization. +* :ref:`atlas-api-organizations-updateOrganizationInvitation` - 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. + +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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +* :ref:`atlas-api-organizations-updateOrganizationRoles` - 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. + +Updates the roles of the specified user in the specified organization. +* :ref:`atlas-api-organizations-updateOrganizationSettings` - 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. + +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 52332e9899..65d734e5c6 100644 --- a/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt +++ b/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt @@ -12,7 +12,10 @@ atlas api performanceAdvisor disableSlowOperationThresholding :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. +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. + +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 07ab856a53..897f809919 100644 --- a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt +++ b/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt @@ -12,7 +12,10 @@ atlas api performanceAdvisor enableSlowOperationThresholding :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Enables MongoDB Cloud to use its slow operation threshold for the specified project. +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. + +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 92ea589e22..451d74d568 100644 --- a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt +++ b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt @@ -12,7 +12,10 @@ atlas api performanceAdvisor getManagedSlowMs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Get whether the Managed Slow MS feature is enabled. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getManagedSlowMs. diff --git a/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt index 1f3daa5834..b738cf0a69 100644 --- a/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt +++ b/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt @@ -12,7 +12,10 @@ atlas api performanceAdvisor getServerlessAutoIndexing :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Get whether the Serverless Auto Indexing feature is enabled. +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. + +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 4eb1b3bc97..ec892fb5f7 100644 --- a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt @@ -12,7 +12,10 @@ atlas api performanceAdvisor listClusterSuggestedIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests. +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. + +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 a12c6ff813..485879c254 100644 --- a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt @@ -12,7 +12,10 @@ atlas api performanceAdvisor listDropIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests to drop. +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. + +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 e091e4766d..ebb3927561 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt @@ -12,7 +12,10 @@ atlas api performanceAdvisor listSchemaAdvice :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the schema suggestions that the Performance Advisor detects. +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. + +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 bd64ac5ac1..1aade18e19 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt @@ -12,7 +12,10 @@ atlas api performanceAdvisor listSlowQueries :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. +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. + +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 ce048515ca..e4daf5bd19 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt @@ -12,7 +12,10 @@ atlas api performanceAdvisor listSlowQueryNamespaces :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. +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. + +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 80509f8bbf..5440402f97 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt @@ -12,7 +12,10 @@ atlas api performanceAdvisor listSuggestedIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests. +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. + +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 2f4ea1ca8a..708aae7a47 100644 --- a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt +++ b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt @@ -12,7 +12,10 @@ atlas api performanceAdvisor setServerlessAutoIndexing :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Set whether the Serverless Auto Indexing feature is enabled. +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. + +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 64c082a920..0d2b8e30e1 100644 --- a/docs/command/atlas-api-performanceAdvisor.txt +++ b/docs/command/atlas-api-performanceAdvisor.txt @@ -12,7 +12,10 @@ atlas api performanceAdvisor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns suggested indexes and slow query data for a database deployment. +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. + +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. @@ -51,17 +54,50 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-performanceAdvisor-disableSlowOperationThresholding` - `Public Preview: please provide feedback at `_: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. -* :ref:`atlas-api-performanceAdvisor-enableSlowOperationThresholding` - `Public Preview: please provide feedback at `_: Enables MongoDB Cloud to use its slow operation threshold for the specified project. -* :ref:`atlas-api-performanceAdvisor-getManagedSlowMs` - `Public Preview: please provide feedback at `_: Get whether the Managed Slow MS feature is enabled. -* :ref:`atlas-api-performanceAdvisor-getServerlessAutoIndexing` - `Public Preview: please provide feedback at `_: Get whether the Serverless Auto Indexing feature is enabled. -* :ref:`atlas-api-performanceAdvisor-listClusterSuggestedIndexes` - `Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests. -* :ref:`atlas-api-performanceAdvisor-listDropIndexes` - `Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests to drop. -* :ref:`atlas-api-performanceAdvisor-listSchemaAdvice` - `Public Preview: please provide feedback at `_: Returns the schema suggestions that the Performance Advisor detects. -* :ref:`atlas-api-performanceAdvisor-listSlowQueries` - `Public Preview: please provide feedback at `_: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. -* :ref:`atlas-api-performanceAdvisor-listSlowQueryNamespaces` - `Public Preview: please provide feedback at `_: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. -* :ref:`atlas-api-performanceAdvisor-listSuggestedIndexes` - `Public Preview: please provide feedback at `_: Returns the indexes that the Performance Advisor suggests. -* :ref:`atlas-api-performanceAdvisor-setServerlessAutoIndexing` - `Public Preview: please provide feedback at `_: Set whether the Serverless Auto Indexing feature is enabled. +* :ref:`atlas-api-performanceAdvisor-disableSlowOperationThresholding` - 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. + +Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. +* :ref:`atlas-api-performanceAdvisor-enableSlowOperationThresholding` - 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. + +Enables MongoDB Cloud to use its slow operation threshold for the specified project. +* :ref:`atlas-api-performanceAdvisor-getManagedSlowMs` - 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. + +Get whether the Managed Slow MS feature is enabled. +* :ref:`atlas-api-performanceAdvisor-getServerlessAutoIndexing` - 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. + +Get whether the Serverless Auto Indexing feature is enabled. +* :ref:`atlas-api-performanceAdvisor-listClusterSuggestedIndexes` - 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. + +Returns the indexes that the Performance Advisor suggests. +* :ref:`atlas-api-performanceAdvisor-listDropIndexes` - 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. + +Returns the indexes that the Performance Advisor suggests to drop. +* :ref:`atlas-api-performanceAdvisor-listSchemaAdvice` - 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. + +Returns the schema suggestions that the Performance Advisor detects. +* :ref:`atlas-api-performanceAdvisor-listSlowQueries` - 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. + +Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. +* :ref:`atlas-api-performanceAdvisor-listSlowQueryNamespaces` - 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. + +Returns up to 20 namespaces for collections experiencing slow queries on the specified host. +* :ref:`atlas-api-performanceAdvisor-listSuggestedIndexes` - 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. + +Returns the indexes that the Performance Advisor suggests. +* :ref:`atlas-api-performanceAdvisor-setServerlessAutoIndexing` - 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. + +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 8441fe7a8a..3bfacf21d8 100644 --- a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt @@ -12,7 +12,10 @@ atlas api privateEndpointServices createPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one private endpoint for the specified cloud service provider. +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. + +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 d7d5d9f78c..44bb405c97 100644 --- a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt @@ -12,7 +12,10 @@ atlas api privateEndpointServices createPrivateEndpointService :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one private endpoint service for the specified cloud service provider. +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. + +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 64fcf2d840..9ec4f9d8fe 100644 --- a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt @@ -12,7 +12,10 @@ atlas api privateEndpointServices deletePrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. +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. + +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 64331230ac..0674270600 100644 --- a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt @@ -12,7 +12,10 @@ atlas api privateEndpointServices deletePrivateEndpointService :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one private endpoint service from the specified project. +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. + +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 bb41a0eefa..c37154eabc 100644 --- a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt @@ -12,7 +12,10 @@ atlas api privateEndpointServices getPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the connection state of the specified private endpoint. +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. + +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 ed7a82bc0f..a7efbc187d 100644 --- a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt @@ -12,7 +12,10 @@ atlas api privateEndpointServices getPrivateEndpointService :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the name, interfaces, and state of the specified private endpoint service from one project. +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. + +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 566d1ecc63..b045834919 100644 --- a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt +++ b/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt @@ -12,7 +12,10 @@ atlas api privateEndpointServices getRegionalizedPrivateEndpointSetting :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. +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. + +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 8c975d6d11..a876d96498 100644 --- a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt +++ b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt @@ -12,7 +12,10 @@ atlas api privateEndpointServices listPrivateEndpointServices :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. +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. + +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 724c824fbc..aa563992ac 100644 --- a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt +++ b/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt @@ -12,7 +12,10 @@ atlas api privateEndpointServices toggleRegionalizedPrivateEndpointSetting :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. +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. + +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 89bf2afea8..d642fd79f0 100644 --- a/docs/command/atlas-api-privateEndpointServices.txt +++ b/docs/command/atlas-api-privateEndpointServices.txt @@ -12,7 +12,10 @@ atlas api privateEndpointServices :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes private endpoint services. +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. + +Returns, adds, edits, and removes private endpoint services. Options ------- @@ -49,15 +52,42 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-privateEndpointServices-createPrivateEndpoint` - `Public Preview: please provide feedback at `_: Creates one private endpoint for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-createPrivateEndpointService` - `Public Preview: please provide feedback at `_: Creates one private endpoint service for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpoint` - `Public Preview: please provide feedback at `_: 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 at `_: Removes one private endpoint service from the specified project. -* :ref:`atlas-api-privateEndpointServices-getPrivateEndpoint` - `Public Preview: please provide feedback at `_: Returns the connection state of the specified private endpoint. -* :ref:`atlas-api-privateEndpointServices-getPrivateEndpointService` - `Public Preview: please provide feedback at `_: 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 at `_: 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 at `_: 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 at `_: 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` - 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. + +Creates one private endpoint for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-createPrivateEndpointService` - 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. + +Creates one private endpoint service for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpoint` - 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. + +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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +* :ref:`atlas-api-privateEndpointServices-getPrivateEndpoint` - 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. + +Returns the connection state of the specified private endpoint. +* :ref:`atlas-api-privateEndpointServices-getPrivateEndpointService` - 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. + +Returns the name, interfaces, and state of the specified private endpoint service from one project. +* :ref:`atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting` - 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. + +Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. +* :ref:`atlas-api-privateEndpointServices-listPrivateEndpointServices` - 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. + +Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting` - 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. + +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 8761bd5fce..1eca7f3325 100644 --- a/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt @@ -12,7 +12,10 @@ atlas api programmaticApiKeys addProjectApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Assigns the specified organization API key to the specified project. +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. + +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 5d72a42b02..a48e56b759 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt @@ -12,7 +12,10 @@ atlas api programmaticApiKeys createApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one API key for the specified organization. +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. + +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 02407bb1d8..8db86d4664 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt @@ -12,7 +12,10 @@ atlas api programmaticApiKeys createApiKeyAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates the access list entries for the specified organization API key. +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. + +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 9a11a3153e..5e26673cd0 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt @@ -12,7 +12,10 @@ atlas api programmaticApiKeys createProjectApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates and assigns the specified organization API key to the specified project. +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. + +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 5caa4fd311..9c76e29450 100644 --- a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt @@ -12,7 +12,10 @@ atlas api programmaticApiKeys deleteApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one organization API key from the specified organization. +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. + +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 02eda0c405..16e4a77382 100644 --- a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt +++ b/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt @@ -12,7 +12,10 @@ atlas api programmaticApiKeys deleteApiKeyAccessListEntry :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified organization API key. +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. + +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 d99a3fa352..9d5e97066c 100644 --- a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt @@ -12,7 +12,10 @@ atlas api programmaticApiKeys getApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one organization API key. +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. + +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 1b06bf06e2..92b4c3f86f 100644 --- a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt +++ b/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt @@ -12,7 +12,10 @@ atlas api programmaticApiKeys getApiKeyAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one access list entry for the specified organization API key. +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. + +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 9bff1a8a70..21598027ba 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt @@ -12,7 +12,10 @@ atlas api programmaticApiKeys listApiKeyAccessListsEntries :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all access list entries that you configured for the specified organization API key. +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. + +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 e22b699d52..af85aef85a 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt @@ -12,7 +12,10 @@ atlas api programmaticApiKeys listApiKeys :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all organization API keys for the specified organization. +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. + +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 bbfa913277..f0813166f5 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt @@ -12,7 +12,10 @@ atlas api programmaticApiKeys listProjectApiKeys :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all organization API keys that you assigned to the specified project. +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. + +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 4aedffa8b5..384cd8c0d2 100644 --- a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt @@ -12,7 +12,10 @@ atlas api programmaticApiKeys removeProjectApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one organization API key from the specified project. +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. + +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 054d38cd6c..3e32d6d3d5 100644 --- a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt @@ -12,7 +12,10 @@ atlas api programmaticApiKeys updateApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one organization API key in the specified organization. +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. + +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 ae795624f8..e10d49fad0 100644 --- a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt +++ b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt @@ -12,7 +12,10 @@ atlas api programmaticApiKeys updateApiKeyRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the roles of the organization API key that you specify for the project that you specify. +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. + +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 4fccf957cb..bfe8b1d775 100644 --- a/docs/command/atlas-api-programmaticApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys.txt @@ -12,7 +12,10 @@ atlas api programmaticApiKeys :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. +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. + +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. @@ -51,20 +54,62 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-programmaticApiKeys-addProjectApiKey` - `Public Preview: please provide feedback at `_: Assigns the specified organization API key to the specified project. -* :ref:`atlas-api-programmaticApiKeys-createApiKey` - `Public Preview: please provide feedback at `_: Creates one API key for the specified organization. -* :ref:`atlas-api-programmaticApiKeys-createApiKeyAccessList` - `Public Preview: please provide feedback at `_: Creates the access list entries for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-createProjectApiKey` - `Public Preview: please provide feedback at `_: Creates and assigns the specified organization API key to the specified project. -* :ref:`atlas-api-programmaticApiKeys-deleteApiKey` - `Public Preview: please provide feedback at `_: Removes one organization API key from the specified organization. -* :ref:`atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry` - `Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-getApiKey` - `Public Preview: please provide feedback at `_: Returns one organization API key. -* :ref:`atlas-api-programmaticApiKeys-getApiKeyAccessList` - `Public Preview: please provide feedback at `_: Returns one access list entry for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries` - `Public Preview: please provide feedback at `_: Returns all access list entries that you configured for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-listApiKeys` - `Public Preview: please provide feedback at `_: Returns all organization API keys for the specified organization. -* :ref:`atlas-api-programmaticApiKeys-listProjectApiKeys` - `Public Preview: please provide feedback at `_: Returns all organization API keys that you assigned to the specified project. -* :ref:`atlas-api-programmaticApiKeys-removeProjectApiKey` - `Public Preview: please provide feedback at `_: Removes one organization API key from the specified project. -* :ref:`atlas-api-programmaticApiKeys-updateApiKey` - `Public Preview: please provide feedback at `_: Updates one organization API key in the specified organization. -* :ref:`atlas-api-programmaticApiKeys-updateApiKeyRoles` - `Public Preview: please provide feedback at `_: Updates the roles of the organization API key that you specify for the project that you specify. +* :ref:`atlas-api-programmaticApiKeys-addProjectApiKey` - 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. + +Assigns the specified organization API key to the specified project. +* :ref:`atlas-api-programmaticApiKeys-createApiKey` - 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. + +Creates one API key for the specified organization. +* :ref:`atlas-api-programmaticApiKeys-createApiKeyAccessList` - 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. + +Creates the access list entries for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-createProjectApiKey` - 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. + +Creates and assigns the specified organization API key to the specified project. +* :ref:`atlas-api-programmaticApiKeys-deleteApiKey` - 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. + +Removes one organization API key from the specified organization. +* :ref:`atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry` - 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. + +Removes the specified access list entry from the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-getApiKey` - 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. + +Returns one organization API key. +* :ref:`atlas-api-programmaticApiKeys-getApiKeyAccessList` - 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. + +Returns one access list entry for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries` - 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. + +Returns all access list entries that you configured for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-listApiKeys` - 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. + +Returns all organization API keys for the specified organization. +* :ref:`atlas-api-programmaticApiKeys-listProjectApiKeys` - 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. + +Returns all organization API keys that you assigned to the specified project. +* :ref:`atlas-api-programmaticApiKeys-removeProjectApiKey` - 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. + +Removes one organization API key from the specified project. +* :ref:`atlas-api-programmaticApiKeys-updateApiKey` - 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. + +Updates one organization API key in the specified organization. +* :ref:`atlas-api-programmaticApiKeys-updateApiKeyRoles` - 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. + +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 b270e58c12..b6a01d0415 100644 --- a/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt @@ -12,7 +12,10 @@ atlas api projectIpAccessList createProjectIpAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one or more access list entries to the specified project. +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. + +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 875305fab2..bd5a5bc40e 100644 --- a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt @@ -12,7 +12,10 @@ atlas api projectIpAccessList deleteProjectIpAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one access list entry from the specified project's IP access list. +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. + +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 d4ec658254..5691110aea 100644 --- a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt +++ b/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt @@ -12,7 +12,10 @@ atlas api projectIpAccessList getProjectIpAccessListStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the status of one project IP access list entry. +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. + +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 0a14f691da..497df62798 100644 --- a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt +++ b/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt @@ -12,7 +12,10 @@ atlas api projectIpAccessList getProjectIpList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one access list entry from the specified project's IP access list. +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. + +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 38898d5ab9..eac439637f 100644 --- a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt +++ b/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt @@ -12,7 +12,10 @@ atlas api projectIpAccessList listProjectIpAccessLists :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all access list entries from the specified project's IP access list. +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. + +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 7ed6dd81bb..01022ee0cd 100644 --- a/docs/command/atlas-api-projectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList.txt @@ -12,7 +12,10 @@ atlas api projectIpAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes network access limits to database deployments in Atlas. +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. + +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. @@ -51,11 +54,26 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projectIpAccessList-createProjectIpAccessList` - `Public Preview: please provide feedback at `_: Adds one or more access list entries to the specified project. -* :ref:`atlas-api-projectIpAccessList-deleteProjectIpAccessList` - `Public Preview: please provide feedback at `_: Removes one access list entry from the specified project's IP access list. -* :ref:`atlas-api-projectIpAccessList-getProjectIpAccessListStatus` - `Public Preview: please provide feedback at `_: Returns the status of one project IP access list entry. -* :ref:`atlas-api-projectIpAccessList-getProjectIpList` - `Public Preview: please provide feedback at `_: Returns one access list entry from the specified project's IP access list. -* :ref:`atlas-api-projectIpAccessList-listProjectIpAccessLists` - `Public Preview: please provide feedback at `_: Returns all access list entries from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-createProjectIpAccessList` - 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. + +Adds one or more access list entries to the specified project. +* :ref:`atlas-api-projectIpAccessList-deleteProjectIpAccessList` - 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. + +Removes one access list entry from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-getProjectIpAccessListStatus` - 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. + +Returns the status of one project IP access list entry. +* :ref:`atlas-api-projectIpAccessList-getProjectIpList` - 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. + +Returns one access list entry from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-listProjectIpAccessLists` - 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. + +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 ef1d68283a..eff59fec77 100644 --- a/docs/command/atlas-api-projects-addUserToProject.txt +++ b/docs/command/atlas-api-projects-addUserToProject.txt @@ -12,7 +12,10 @@ atlas api projects addUserToProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to the specified project. +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. + +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 6d8c30392b..4f11c8e000 100644 --- a/docs/command/atlas-api-projects-createProject.txt +++ b/docs/command/atlas-api-projects-createProject.txt @@ -12,7 +12,10 @@ atlas api projects createProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one project. +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. + +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 a8daf5a7d1..7b2167d9b2 100644 --- a/docs/command/atlas-api-projects-createProjectInvitation.txt +++ b/docs/command/atlas-api-projects-createProjectInvitation.txt @@ -12,7 +12,10 @@ atlas api projects createProjectInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Invites one MongoDB Cloud user to join the specified project. +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. + +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 0fa7d480b1..f49b37cf69 100644 --- a/docs/command/atlas-api-projects-deleteProject.txt +++ b/docs/command/atlas-api-projects-deleteProject.txt @@ -12,7 +12,10 @@ atlas api projects deleteProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified project. +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. + +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 02f6a52d1a..a82212adb7 100644 --- a/docs/command/atlas-api-projects-deleteProjectInvitation.txt +++ b/docs/command/atlas-api-projects-deleteProjectInvitation.txt @@ -12,7 +12,10 @@ atlas api projects deleteProjectInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. +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. + +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 1b4a5a2e2f..25e37ddd4d 100644 --- a/docs/command/atlas-api-projects-deleteProjectLimit.txt +++ b/docs/command/atlas-api-projects-deleteProjectLimit.txt @@ -12,7 +12,10 @@ atlas api projects deleteProjectLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified project limit. +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. + +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 a89f72465e..00bb02b8ac 100644 --- a/docs/command/atlas-api-projects-getProject.txt +++ b/docs/command/atlas-api-projects-getProject.txt @@ -12,7 +12,10 @@ atlas api projects getProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the specified project. +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. + +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 43952f13bd..2616c53eee 100644 --- a/docs/command/atlas-api-projects-getProjectByName.txt +++ b/docs/command/atlas-api-projects-getProjectByName.txt @@ -12,7 +12,10 @@ atlas api projects getProjectByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the project identified by its name. +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. + +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 e6cbc1f9fc..871522180f 100644 --- a/docs/command/atlas-api-projects-getProjectInvitation.txt +++ b/docs/command/atlas-api-projects-getProjectInvitation.txt @@ -12,7 +12,10 @@ atlas api projects getProjectInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one pending invitation to the specified project. +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. + +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 80b01df2e0..35b6ade4d4 100644 --- a/docs/command/atlas-api-projects-getProjectLimit.txt +++ b/docs/command/atlas-api-projects-getProjectLimit.txt @@ -12,7 +12,10 @@ atlas api projects getProjectLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the specified limit for the specified project. +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. + +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 bb7998cc69..d36eb987a8 100644 --- a/docs/command/atlas-api-projects-getProjectLtsVersions.txt +++ b/docs/command/atlas-api-projects-getProjectLtsVersions.txt @@ -12,7 +12,10 @@ atlas api projects getProjectLtsVersions :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLtsVersions. diff --git a/docs/command/atlas-api-projects-getProjectSettings.txt b/docs/command/atlas-api-projects-getProjectSettings.txt index b95bd81426..3112feca4a 100644 --- a/docs/command/atlas-api-projects-getProjectSettings.txt +++ b/docs/command/atlas-api-projects-getProjectSettings.txt @@ -12,7 +12,10 @@ atlas api projects getProjectSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about the specified project's settings. +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. + +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 0178ba2800..6aaf2539b5 100644 --- a/docs/command/atlas-api-projects-listProjectInvitations.txt +++ b/docs/command/atlas-api-projects-listProjectInvitations.txt @@ -12,7 +12,10 @@ atlas api projects listProjectInvitations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all pending invitations to the specified project. +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. + +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 5704d8f066..a9c945db95 100644 --- a/docs/command/atlas-api-projects-listProjectLimits.txt +++ b/docs/command/atlas-api-projects-listProjectLimits.txt @@ -12,7 +12,10 @@ atlas api projects listProjectLimits :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all the limits for the specified project. +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. + +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 f0b9dfc43e..6f3f25d1fd 100644 --- a/docs/command/atlas-api-projects-listProjects.txt +++ b/docs/command/atlas-api-projects-listProjects.txt @@ -12,7 +12,10 @@ atlas api projects listProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details about all projects. +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. + +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 65963ac346..f1eba66536 100644 --- a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt +++ b/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt @@ -12,7 +12,10 @@ atlas api projects migrateProjectToAnotherOrg :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Migrates a project from its current organization to another organization. +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. + +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 4289f7ed02..8c9fd5719f 100644 --- a/docs/command/atlas-api-projects-returnAllIpAddresses.txt +++ b/docs/command/atlas-api-projects-returnAllIpAddresses.txt @@ -12,7 +12,10 @@ atlas api projects returnAllIpAddresses :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all IP addresses for this project. +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. + +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 98940b852c..ffeac40c4e 100644 --- a/docs/command/atlas-api-projects-setProjectLimit.txt +++ b/docs/command/atlas-api-projects-setProjectLimit.txt @@ -12,7 +12,10 @@ atlas api projects setProjectLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Sets the specified project limit. +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. + +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 e79239a862..fd9a33df58 100644 --- a/docs/command/atlas-api-projects-updateProject.txt +++ b/docs/command/atlas-api-projects-updateProject.txt @@ -12,7 +12,10 @@ atlas api projects updateProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the human-readable label that identifies the specified project, or the tags associated with the project. +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. + +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 07b65cdb3b..d336d6d0c3 100644 --- a/docs/command/atlas-api-projects-updateProjectInvitation.txt +++ b/docs/command/atlas-api-projects-updateProjectInvitation.txt @@ -12,7 +12,10 @@ atlas api projects updateProjectInvitation :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. +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. + +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 5cdf059b79..f0ec6c6199 100644 --- a/docs/command/atlas-api-projects-updateProjectInvitationById.txt +++ b/docs/command/atlas-api-projects-updateProjectInvitationById.txt @@ -12,7 +12,10 @@ atlas api projects updateProjectInvitationById :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the details of one pending invitation, identified by its unique ID, to the specified project. +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. + +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 0fc15c669f..2411ac9c93 100644 --- a/docs/command/atlas-api-projects-updateProjectRoles.txt +++ b/docs/command/atlas-api-projects-updateProjectRoles.txt @@ -12,7 +12,10 @@ atlas api projects updateProjectRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the roles of the specified user in the specified project. +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. + +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 bdb612e5f5..be348ca707 100644 --- a/docs/command/atlas-api-projects-updateProjectSettings.txt +++ b/docs/command/atlas-api-projects-updateProjectSettings.txt @@ -12,7 +12,10 @@ atlas api projects updateProjectSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the settings of the specified project. +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. + +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 e3b605e506..873fa4d5b3 100644 --- a/docs/command/atlas-api-projects.txt +++ b/docs/command/atlas-api-projects.txt @@ -12,7 +12,10 @@ atlas api projects :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. +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. + +Returns, adds, and edits collections of clusters and users in MongoDB Cloud. Options ------- @@ -49,29 +52,98 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projects-addUserToProject` - `Public Preview: please provide feedback at `_: Adds one MongoDB Cloud user to the specified project. -* :ref:`atlas-api-projects-createProject` - `Public Preview: please provide feedback at `_: Creates one project. -* :ref:`atlas-api-projects-createProjectInvitation` - `Public Preview: please provide feedback at `_: Invites one MongoDB Cloud user to join the specified project. -* :ref:`atlas-api-projects-deleteProject` - `Public Preview: please provide feedback at `_: Removes the specified project. -* :ref:`atlas-api-projects-deleteProjectInvitation` - `Public Preview: please provide feedback at `_: 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 at `_: Removes the specified project limit. -* :ref:`atlas-api-projects-getProject` - `Public Preview: please provide feedback at `_: Returns details about the specified project. -* :ref:`atlas-api-projects-getProjectByName` - `Public Preview: please provide feedback at `_: Returns details about the project identified by its name. -* :ref:`atlas-api-projects-getProjectInvitation` - `Public Preview: please provide feedback at `_: Returns the details of one pending invitation to the specified project. -* :ref:`atlas-api-projects-getProjectLimit` - `Public Preview: please provide feedback at `_: Returns the specified limit for the specified project. -* :ref:`atlas-api-projects-getProjectLtsVersions` - `Public Preview: please provide feedback at `_: 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 at `_: Returns details about the specified project's settings. -* :ref:`atlas-api-projects-listProjectInvitations` - `Public Preview: please provide feedback at `_: Returns all pending invitations to the specified project. -* :ref:`atlas-api-projects-listProjectLimits` - `Public Preview: please provide feedback at `_: Returns all the limits for the specified project. -* :ref:`atlas-api-projects-listProjects` - `Public Preview: please provide feedback at `_: Returns details about all projects. -* :ref:`atlas-api-projects-migrateProjectToAnotherOrg` - `Public Preview: please provide feedback at `_: Migrates a project from its current organization to another organization. -* :ref:`atlas-api-projects-returnAllIpAddresses` - `Public Preview: please provide feedback at `_: Returns all IP addresses for this project. -* :ref:`atlas-api-projects-setProjectLimit` - `Public Preview: please provide feedback at `_: Sets the specified project limit. -* :ref:`atlas-api-projects-updateProject` - `Public Preview: please provide feedback at `_: 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 at `_: 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 at `_: 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 at `_: Updates the roles of the specified user in the specified project. -* :ref:`atlas-api-projects-updateProjectSettings` - `Public Preview: please provide feedback at `_: Updates the settings of the specified project. +* :ref:`atlas-api-projects-addUserToProject` - 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. + +Adds one MongoDB Cloud user to the specified project. +* :ref:`atlas-api-projects-createProject` - 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. + +Creates one project. +* :ref:`atlas-api-projects-createProjectInvitation` - 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. + +Invites one MongoDB Cloud user to join the specified project. +* :ref:`atlas-api-projects-deleteProject` - 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. + +Removes the specified project. +* :ref:`atlas-api-projects-deleteProjectInvitation` - 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. + +Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. +* :ref:`atlas-api-projects-deleteProjectLimit` - 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. + +Removes the specified project limit. +* :ref:`atlas-api-projects-getProject` - 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. + +Returns details about the specified project. +* :ref:`atlas-api-projects-getProjectByName` - 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. + +Returns details about the project identified by its name. +* :ref:`atlas-api-projects-getProjectInvitation` - 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. + +Returns the details of one pending invitation to the specified project. +* :ref:`atlas-api-projects-getProjectLimit` - 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. + +Returns the specified limit for the specified project. +* :ref:`atlas-api-projects-getProjectLtsVersions` - 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. + +Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. +* :ref:`atlas-api-projects-getProjectSettings` - 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. + +Returns details about the specified project's settings. +* :ref:`atlas-api-projects-listProjectInvitations` - 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. + +Returns all pending invitations to the specified project. +* :ref:`atlas-api-projects-listProjectLimits` - 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. + +Returns all the limits for the specified project. +* :ref:`atlas-api-projects-listProjects` - 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. + +Returns details about all projects. +* :ref:`atlas-api-projects-migrateProjectToAnotherOrg` - 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. + +Migrates a project from its current organization to another organization. +* :ref:`atlas-api-projects-returnAllIpAddresses` - 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. + +Returns all IP addresses for this project. +* :ref:`atlas-api-projects-setProjectLimit` - 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. + +Sets the specified project limit. +* :ref:`atlas-api-projects-updateProject` - 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. + +Updates the human-readable label that identifies the specified project, or the tags associated with the project. +* :ref:`atlas-api-projects-updateProjectInvitation` - 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. + +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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +* :ref:`atlas-api-projects-updateProjectRoles` - 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. + +Updates the roles of the specified user in the specified project. +* :ref:`atlas-api-projects-updateProjectSettings` - 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. + +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 8fe0258bda..768a092e72 100644 --- a/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt @@ -12,7 +12,10 @@ atlas api pushBasedLogExport createPushBasedLogConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Configures the project level settings for the push-based log export feature. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/createPushBasedLogConfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt index c5c7ed4125..a17122978c 100644 --- a/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt @@ -12,7 +12,10 @@ atlas api pushBasedLogExport deletePushBasedLogConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Disables the push-based log export feature by resetting the project level settings to its default configuration. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/deletePushBasedLogConfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt index ae87cf590e..6a4cd34fd3 100644 --- a/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt @@ -12,7 +12,10 @@ atlas api pushBasedLogExport getPushBasedLogConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Fetches the current project level settings for the push-based log export feature. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/getPushBasedLogConfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt index c8efc8dc23..a3d30c068f 100644 --- a/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt @@ -12,7 +12,10 @@ atlas api pushBasedLogExport updatePushBasedLogConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the project level settings for the push-based log export feature. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/updatePushBasedLogConfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport.txt b/docs/command/atlas-api-pushBasedLogExport.txt index 030946a346..f717281f23 100644 --- a/docs/command/atlas-api-pushBasedLogExport.txt +++ b/docs/command/atlas-api-pushBasedLogExport.txt @@ -12,7 +12,10 @@ atlas api pushBasedLogExport :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. +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. + +You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes. @@ -51,10 +54,22 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-pushBasedLogExport-createPushBasedLogConfiguration` - `Public Preview: please provide feedback at `_: Configures the project level settings for the push-based log export feature. -* :ref:`atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration` - `Public Preview: please provide feedback at `_: 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 at `_: Fetches the current project level settings for the push-based log export feature. -* :ref:`atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration` - `Public Preview: please provide feedback at `_: Updates the project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-createPushBasedLogConfiguration` - 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. + +Configures the project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration` - 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. + +Disables the push-based log export feature by resetting the project level settings to its default configuration. +* :ref:`atlas-api-pushBasedLogExport-getPushBasedLogConfiguration` - 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. + +Fetches the current project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration` - 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. + +Updates the project level settings for the push-based log export feature. .. toctree:: diff --git a/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt index 93b63c0f25..463dbf9f69 100644 --- a/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt @@ -12,7 +12,10 @@ atlas api resourcePolicies createAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Create one Atlas Resource Policy for an org. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/createAtlasResourcePolicy. diff --git a/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt index 2b7ce7f30a..3ad00f734b 100644 --- a/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt @@ -12,7 +12,10 @@ atlas api resourcePolicies deleteAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Delete one Atlas Resource Policy for an org. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/deleteAtlasResourcePolicy. diff --git a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt index 2f057a942b..fdc55e27d8 100644 --- a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt @@ -12,7 +12,10 @@ atlas api resourcePolicies getAtlasResourcePolicies :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return all Atlas Resource Policies for the org. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicies. diff --git a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt index 01322ea5a1..8b157f9ca2 100644 --- a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt @@ -12,7 +12,10 @@ atlas api resourcePolicies getAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return one Atlas Resource Policy for an org. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicy. diff --git a/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt b/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt index 6821b00510..8d158cd735 100644 --- a/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt +++ b/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt @@ -12,7 +12,10 @@ atlas api resourcePolicies getResourcesNonCompliant :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return all non-compliant resources for an org. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getResourcesNonCompliant. diff --git a/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt index f67689b495..f53ac3da84 100644 --- a/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt @@ -12,7 +12,10 @@ atlas api resourcePolicies updateAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Update one Atlas Resource Policy for an org. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/updateAtlasResourcePolicy. diff --git a/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt index c9530573ad..91c572c0fc 100644 --- a/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt @@ -12,7 +12,10 @@ atlas api resourcePolicies validateAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Validate one Atlas Resource Policy for an org. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/validateAtlasResourcePolicy. diff --git a/docs/command/atlas-api-resourcePolicies.txt b/docs/command/atlas-api-resourcePolicies.txt index bc963944e2..1dfcd868e3 100644 --- a/docs/command/atlas-api-resourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies.txt @@ -12,7 +12,10 @@ atlas api resourcePolicies :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Configure and manage Atlas Resource Policies within your organization. +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. + +Configure and manage Atlas Resource Policies within your organization. Options ------- @@ -49,13 +52,34 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-resourcePolicies-createAtlasResourcePolicy` - `Public Preview: please provide feedback at `_: Create one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-deleteAtlasResourcePolicy` - `Public Preview: please provide feedback at `_: Delete one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicies` - `Public Preview: please provide feedback at `_: Return all Atlas Resource Policies for the org. -* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicy` - `Public Preview: please provide feedback at `_: Return one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getResourcesNonCompliant` - `Public Preview: please provide feedback at `_: Return all non-compliant resources for an org. -* :ref:`atlas-api-resourcePolicies-updateAtlasResourcePolicy` - `Public Preview: please provide feedback at `_: Update one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-validateAtlasResourcePolicy` - `Public Preview: please provide feedback at `_: Validate one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-createAtlasResourcePolicy` - 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. + +Create one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-deleteAtlasResourcePolicy` - 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. + +Delete one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicies` - 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. + +Return all Atlas Resource Policies for the org. +* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicy` - 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. + +Return one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-getResourcesNonCompliant` - 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. + +Return all non-compliant resources for an org. +* :ref:`atlas-api-resourcePolicies-updateAtlasResourcePolicy` - 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. + +Update one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-validateAtlasResourcePolicy` - 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. + +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 14aed7692f..2457c08e66 100644 --- a/docs/command/atlas-api-rollingIndex-createRollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex-createRollingIndex.txt @@ -12,7 +12,10 @@ atlas api rollingIndex createRollingIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates an index on the cluster identified by its name in a rolling manner. +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. + +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 44bd0f715e..044d986194 100644 --- a/docs/command/atlas-api-rollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex.txt @@ -12,7 +12,10 @@ atlas api rollingIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one index to a database deployment in a rolling manner. +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. + +Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an M0 free cluster or M2/M5 shared cluster. @@ -51,7 +54,10 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-rollingIndex-createRollingIndex` - `Public Preview: please provide feedback at `_: Creates an index on the cluster identified by its name in a rolling manner. +* :ref:`atlas-api-rollingIndex-createRollingIndex` - 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. + +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 a5218d9b7c..c31bf71e26 100644 --- a/docs/command/atlas-api-root-getSystemStatus.txt +++ b/docs/command/atlas-api-root-getSystemStatus.txt @@ -12,7 +12,10 @@ atlas api root getSystemStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: This resource returns information about the MongoDB application along with API key meta data. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Root/operation/getSystemStatus. diff --git a/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt b/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt index bd896231c0..80fce4d35c 100644 --- a/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt +++ b/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt @@ -12,7 +12,10 @@ atlas api root returnAllControlPlaneIpAddresses :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all control plane IP addresses. +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. + +Returns all control plane IP addresses. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/returnAllControlPlaneIpAddresses. diff --git a/docs/command/atlas-api-root.txt b/docs/command/atlas-api-root.txt index 123c460b04..3bde6dd02d 100644 --- a/docs/command/atlas-api-root.txt +++ b/docs/command/atlas-api-root.txt @@ -12,7 +12,10 @@ atlas api root :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. +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. + +Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API. @@ -51,8 +54,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-root-getSystemStatus` - `Public Preview: please provide feedback at `_: This resource returns information about the MongoDB application along with API key meta data. -* :ref:`atlas-api-root-returnAllControlPlaneIpAddresses` - `Public Preview: please provide feedback at `_: Returns all control plane IP addresses. +* :ref:`atlas-api-root-getSystemStatus` - 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. + +This resource returns information about the MongoDB application along with API key meta data. +* :ref:`atlas-api-root-returnAllControlPlaneIpAddresses` - 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. + +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 1a552bfdf7..d70856c523 100644 --- a/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt @@ -12,7 +12,10 @@ atlas api serverlessInstances createServerlessInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Update as of Feb 2025: This endpoint now creates a Flex cluster instead. +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. + +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 4c9767ce27..c29403d65e 100644 --- a/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt @@ -12,7 +12,10 @@ atlas api serverlessInstances deleteServerlessInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one serverless instance from the specified project. +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. + +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 098240884d..c1bc231ac6 100644 --- a/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt @@ -12,7 +12,10 @@ atlas api serverlessInstances getServerlessInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details for one serverless instance in the specified project. +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. + +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 f256bda253..f1166ded7f 100644 --- a/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt +++ b/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt @@ -12,7 +12,10 @@ atlas api serverlessInstances listServerlessInstances :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details for all serverless instances in the specified project. +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. + +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 e72c4a3e9c..53274119a3 100644 --- a/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt @@ -12,7 +12,10 @@ atlas api serverlessInstances updateServerlessInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one serverless instance in the specified project. +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. + +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 eaacf209fe..f3a46009ec 100644 --- a/docs/command/atlas-api-serverlessInstances.txt +++ b/docs/command/atlas-api-serverlessInstances.txt @@ -12,7 +12,10 @@ atlas api serverlessInstances :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes serverless instances. +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. + +Returns, adds, edits, and removes serverless instances. Options ------- @@ -49,11 +52,26 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serverlessInstances-createServerlessInstance` - `Public Preview: please provide feedback at `_: Update as of Feb 2025: This endpoint now creates a Flex cluster instead. -* :ref:`atlas-api-serverlessInstances-deleteServerlessInstance` - `Public Preview: please provide feedback at `_: Removes one serverless instance from the specified project. -* :ref:`atlas-api-serverlessInstances-getServerlessInstance` - `Public Preview: please provide feedback at `_: Returns details for one serverless instance in the specified project. -* :ref:`atlas-api-serverlessInstances-listServerlessInstances` - `Public Preview: please provide feedback at `_: Returns details for all serverless instances in the specified project. -* :ref:`atlas-api-serverlessInstances-updateServerlessInstance` - `Public Preview: please provide feedback at `_: Updates one serverless instance in the specified project. +* :ref:`atlas-api-serverlessInstances-createServerlessInstance` - 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. + +Update as of Feb 2025: This endpoint now creates a Flex cluster instead. +* :ref:`atlas-api-serverlessInstances-deleteServerlessInstance` - 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. + +Removes one serverless instance from the specified project. +* :ref:`atlas-api-serverlessInstances-getServerlessInstance` - 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. + +Returns details for one serverless instance in the specified project. +* :ref:`atlas-api-serverlessInstances-listServerlessInstances` - 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. + +Returns details for all serverless instances in the specified project. +* :ref:`atlas-api-serverlessInstances-updateServerlessInstance` - 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. + +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 b9b6755bc7..79615cf0d6 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt @@ -12,7 +12,10 @@ atlas api serverlessPrivateEndpoints createServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one private endpoint for one serverless instance. +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. + +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 99030f9bdf..facb7ffd98 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt @@ -12,7 +12,10 @@ atlas api serverlessPrivateEndpoints deleteServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Remove one private endpoint from one serverless instance. +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. + +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 eccb4ff8da..aa250905d3 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt @@ -12,7 +12,10 @@ atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Return one private endpoint for one serverless instance. +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. + +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 4ec14f63dc..5e429b4abf 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt @@ -12,7 +12,10 @@ atlas api serverlessPrivateEndpoints listServerlessPrivateEndpoints :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all private endpoints for one serverless instance. +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. + +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 2966872870..a7c4b9e6e6 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt @@ -12,7 +12,10 @@ atlas api serverlessPrivateEndpoints updateServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one private endpoint for one serverless instance. +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. + +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 1565530950..96133268b6 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints.txt @@ -12,7 +12,10 @@ atlas api serverlessPrivateEndpoints :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes private endpoints for serverless instances. +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. + +Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial. @@ -51,11 +54,26 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint` - `Public Preview: please provide feedback at `_: Creates one private endpoint for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint` - `Public Preview: please provide feedback at `_: Remove one private endpoint from one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint` - `Public Preview: please provide feedback at `_: Return one private endpoint for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints` - `Public Preview: please provide feedback at `_: Returns all private endpoints for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint` - `Public Preview: please provide feedback at `_: Updates one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint` - 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. + +Creates one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint` - 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. + +Remove one private endpoint from one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint` - 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. + +Return one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints` - 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. + +Returns all private endpoints for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint` - 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. + +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 cece36a99d..4f77e9bec2 100644 --- a/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts addProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Assigns the specified Service Account to the specified Project. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/addProjectServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt index f254e194ba..01263c3bc2 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts createProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one Service Account for the specified Project. +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. + +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 6ce61b547d..ebd1e488a9 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts createProjectServiceAccountAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Add Access List Entries for the specified Service Account for the project. +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. + +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 1fdf716ecf..102a98ce28 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts createProjectServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Create a secret for the specified Service Account in the specified Project. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountSecret. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt index b8996b8c52..0606f6e5f6 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts createServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one Service Account for the specified Organization. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt index 7098195318..265d287991 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts createServiceAccountAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Add Access List Entries for the specified Service Account for the organization. +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. + +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 931f838a71..4807aece49 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts createServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Create a secret for the specified Service Account. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountSecret. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt index 29978dcf8d..93fc674979 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts deleteProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified Service Account from the specified project. +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. + +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 815e3efe32..6684625336 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts deleteProjectServiceAccountAccessListEntry :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified Service Account for the project. +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. + +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 b666cf752b..5b707171b9 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts deleteProjectServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes the specified Service Account secret. +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. + +Deletes the specified Service Account secret. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountSecret. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt index 5ad8eb7abf..d815789064 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts deleteServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes the specified Service Account. +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. + +Deletes the specified Service Account. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt index dabef83ad8..88b4d9f99d 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts deleteServiceAccountAccessListEntry :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified Service Account for the organization. +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. + +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 7976073f39..074602d1f4 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts deleteServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes the specified Service Account secret. +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. + +Deletes the specified Service Account secret. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountSecret. diff --git a/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt index dd9c5c299f..b0f8cf962d 100644 --- a/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts getProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one Service Account in the specified Project. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getProjectServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt index bfbc418d79..e2a1cd2808 100644 --- a/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts getServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the specified Service Account. +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. + +Returns the specified Service Account. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt index ca8cadaa07..77c4aec4a2 100644 --- a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts listProjectServiceAccountAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all access list entries that you configured for the specified Service Account for the project. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccountAccessList. diff --git a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt index 2f321afce3..dff5084a81 100644 --- a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts listProjectServiceAccounts :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Service Accounts for the specified Project. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccounts. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt index 123b93d6d8..6f587c348c 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts listServiceAccountAccessList :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all access list entries that you configured for the specified Service Account for the organization. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountAccessList. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt index 373a785363..17beeaf482 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts listServiceAccountProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of all projects the specified Service Account is a part of. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountProjects. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt index 32c31fcaf1..038ceb42a9 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts listServiceAccounts :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Service Accounts for the specified Organization. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccounts. diff --git a/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt index 24e20a98ae..26b183f459 100644 --- a/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts updateProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates one Service Account in the specified Project. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateProjectServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt index 7dfacf97bb..8fd0189e77 100644 --- a/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts updateServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the specified Service Account in the specified Organization. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts.txt b/docs/command/atlas-api-serviceAccounts.txt index 3d584d002a..e8ffb46a00 100644 --- a/docs/command/atlas-api-serviceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts.txt @@ -12,7 +12,10 @@ atlas api serviceAccounts :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Endpoints for managing Service Accounts and secrets. +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. + +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. @@ -51,28 +54,94 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serviceAccounts-addProjectServiceAccount` - `Public Preview: please provide feedback at `_: Assigns the specified Service Account to the specified Project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccount` - `Public Preview: please provide feedback at `_: Creates one Service Account for the specified Project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountAccessList` - `Public Preview: please provide feedback at `_: Add Access List Entries for the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountSecret` - `Public Preview: please provide feedback at `_: Create a secret for the specified Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-createServiceAccount` - `Public Preview: please provide feedback at `_: Creates one Service Account for the specified Organization. -* :ref:`atlas-api-serviceAccounts-createServiceAccountAccessList` - `Public Preview: please provide feedback at `_: Add Access List Entries for the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-createServiceAccountSecret` - `Public Preview: please provide feedback at `_: Create a secret for the specified Service Account. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccount` - `Public Preview: please provide feedback at `_: Removes the specified Service Account from the specified project. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry` - `Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountSecret` - `Public Preview: please provide feedback at `_: Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccount` - `Public Preview: please provide feedback at `_: Deletes the specified Service Account. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry` - `Public Preview: please provide feedback at `_: Removes the specified access list entry from the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccountSecret` - `Public Preview: please provide feedback at `_: Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-getProjectServiceAccount` - `Public Preview: please provide feedback at `_: Returns one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-getServiceAccount` - `Public Preview: please provide feedback at `_: Returns the specified Service Account. -* :ref:`atlas-api-serviceAccounts-listProjectServiceAccountAccessList` - `Public Preview: please provide feedback at `_: 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 at `_: Returns all Service Accounts for the specified Project. -* :ref:`atlas-api-serviceAccounts-listServiceAccountAccessList` - `Public Preview: please provide feedback at `_: 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 at `_: Returns a list of all projects the specified Service Account is a part of. -* :ref:`atlas-api-serviceAccounts-listServiceAccounts` - `Public Preview: please provide feedback at `_: Returns all Service Accounts for the specified Organization. -* :ref:`atlas-api-serviceAccounts-updateProjectServiceAccount` - `Public Preview: please provide feedback at `_: Updates one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-updateServiceAccount` - `Public Preview: please provide feedback at `_: Updates the specified Service Account in the specified Organization. +* :ref:`atlas-api-serviceAccounts-addProjectServiceAccount` - 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. + +Assigns the specified Service Account to the specified Project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccount` - 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. + +Creates one Service Account for the specified Project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountAccessList` - 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. + +Add Access List Entries for the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountSecret` - 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. + +Create a secret for the specified Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-createServiceAccount` - 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. + +Creates one Service Account for the specified Organization. +* :ref:`atlas-api-serviceAccounts-createServiceAccountAccessList` - 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. + +Add Access List Entries for the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-createServiceAccountSecret` - 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. + +Create a secret for the specified Service Account. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccount` - 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. + +Removes the specified Service Account from the specified project. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry` - 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. + +Removes the specified access list entry from the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountSecret` - 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. + +Deletes the specified Service Account secret. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccount` - 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. + +Deletes the specified Service Account. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry` - 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. + +Removes the specified access list entry from the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccountSecret` - 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. + +Deletes the specified Service Account secret. +* :ref:`atlas-api-serviceAccounts-getProjectServiceAccount` - 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. + +Returns one Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-getServiceAccount` - 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. + +Returns the specified Service Account. +* :ref:`atlas-api-serviceAccounts-listProjectServiceAccountAccessList` - 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. + +Returns all access list entries that you configured for the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-listProjectServiceAccounts` - 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. + +Returns all Service Accounts for the specified Project. +* :ref:`atlas-api-serviceAccounts-listServiceAccountAccessList` - 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. + +Returns all access list entries that you configured for the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-listServiceAccountProjects` - 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. + +Returns a list of all projects the specified Service Account is a part of. +* :ref:`atlas-api-serviceAccounts-listServiceAccounts` - 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. + +Returns all Service Accounts for the specified Organization. +* :ref:`atlas-api-serviceAccounts-updateProjectServiceAccount` - 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. + +Updates one Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-updateServiceAccount` - 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. + +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 2eabdd80a3..e2e08475a6 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt @@ -12,7 +12,10 @@ atlas api sharedTierRestoreJobs createSharedClusterBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Restores the specified M2 or M5 cluster. +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. + +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 2a3f7bac9d..424683fe7d 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt @@ -12,7 +12,10 @@ atlas api sharedTierRestoreJobs getSharedClusterBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the specified restore job for the specified M2 or M5 cluster. +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. + +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 2994b2408a..5f3377d8a6 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt @@ -12,7 +12,10 @@ atlas api sharedTierRestoreJobs listSharedClusterBackupRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all restore jobs for the specified M2 or M5 cluster. +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. + +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 2b22084999..0b043be59d 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs.txt @@ -12,7 +12,10 @@ atlas api sharedTierRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and adds restore jobs for shared-tier database deployments. +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. + +Returns and adds restore jobs for shared-tier database deployments. Options ------- @@ -49,9 +52,18 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob` - `Public Preview: please provide feedback at `_: Restores the specified M2 or M5 cluster. -* :ref:`atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob` - `Public Preview: please provide feedback at `_: Returns the specified restore job for the specified M2 or M5 cluster. -* :ref:`atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs` - `Public Preview: please provide feedback at `_: Returns all restore jobs for the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob` - 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. + +Restores the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob` - 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. + +Returns the specified restore job for the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs` - 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. + +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 dbb1c16b3e..d93e1020df 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt @@ -12,7 +12,10 @@ atlas api sharedTierSnapshots downloadSharedClusterBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Requests one snapshot for the specified shared cluster. +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. + +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 1784e8cfdb..1807cff454 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt @@ -12,7 +12,10 @@ atlas api sharedTierSnapshots getSharedClusterBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details for one snapshot for the specified shared cluster. +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. + +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 243bccbdc6..18551cffe7 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt @@ -12,7 +12,10 @@ atlas api sharedTierSnapshots listSharedClusterBackups :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns details for all snapshots for the specified shared cluster. +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. + +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 310091f249..977d1c6447 100644 --- a/docs/command/atlas-api-sharedTierSnapshots.txt +++ b/docs/command/atlas-api-sharedTierSnapshots.txt @@ -12,7 +12,10 @@ atlas api sharedTierSnapshots :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns and requests to download shared-tier database deployment snapshots. +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. + +Returns and requests to download shared-tier database deployment snapshots. Options ------- @@ -49,9 +52,18 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierSnapshots-downloadSharedClusterBackup` - `Public Preview: please provide feedback at `_: Requests one snapshot for the specified shared cluster. -* :ref:`atlas-api-sharedTierSnapshots-getSharedClusterBackup` - `Public Preview: please provide feedback at `_: Returns details for one snapshot for the specified shared cluster. -* :ref:`atlas-api-sharedTierSnapshots-listSharedClusterBackups` - `Public Preview: please provide feedback at `_: Returns details for all snapshots for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-downloadSharedClusterBackup` - 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. + +Requests one snapshot for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-getSharedClusterBackup` - 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. + +Returns details for one snapshot for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-listSharedClusterBackups` - 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. + +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 d7964756fc..cea09b1d75 100644 --- a/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt @@ -12,7 +12,10 @@ atlas api streams acceptVpcPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Requests the acceptance of an incoming VPC Peering connection. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/acceptVpcPeeringConnection. diff --git a/docs/command/atlas-api-streams-createPrivateLinkConnection.txt b/docs/command/atlas-api-streams-createPrivateLinkConnection.txt index c74964a38a..5123f8764d 100644 --- a/docs/command/atlas-api-streams-createPrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-createPrivateLinkConnection.txt @@ -12,7 +12,10 @@ atlas api streams createPrivateLinkConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one Private Link in the specified project. +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. + +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 0fd271440c..8423e91f12 100644 --- a/docs/command/atlas-api-streams-createStreamConnection.txt +++ b/docs/command/atlas-api-streams-createStreamConnection.txt @@ -12,7 +12,10 @@ atlas api streams createStreamConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one connection for a stream instance in the specified project. +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. + +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 c591af289c..f683b43bc4 100644 --- a/docs/command/atlas-api-streams-createStreamInstance.txt +++ b/docs/command/atlas-api-streams-createStreamInstance.txt @@ -12,7 +12,10 @@ atlas api streams createStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one stream instance in the specified project. +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. + +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 6fe3a7aa2a..0fe0d85a15 100644 --- a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt +++ b/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt @@ -12,7 +12,10 @@ atlas api streams createStreamInstanceWithSampleConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one stream instance in the specified project with sample connections. +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. + +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 60fdb53c3e..0059471f22 100644 --- a/docs/command/atlas-api-streams-createStreamProcessor.txt +++ b/docs/command/atlas-api-streams-createStreamProcessor.txt @@ -12,7 +12,10 @@ atlas api streams createStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Create one Stream Processor within the specified stream instance. +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. + +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 4452bb5b35..1185d97ab2 100644 --- a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt @@ -12,7 +12,10 @@ atlas api streams deletePrivateLinkConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes one Private Link in the specified project. +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. + +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 4a0a6ec01a..5493fd392e 100644 --- a/docs/command/atlas-api-streams-deleteStreamConnection.txt +++ b/docs/command/atlas-api-streams-deleteStreamConnection.txt @@ -12,7 +12,10 @@ atlas api streams deleteStreamConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Delete one connection of the specified stream instance. +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. + +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 61c50d9fa0..abea30cfc6 100644 --- a/docs/command/atlas-api-streams-deleteStreamInstance.txt +++ b/docs/command/atlas-api-streams-deleteStreamInstance.txt @@ -12,7 +12,10 @@ atlas api streams deleteStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Delete one stream instance in the specified project. +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. + +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 f275daa181..0d4ae31771 100644 --- a/docs/command/atlas-api-streams-deleteStreamProcessor.txt +++ b/docs/command/atlas-api-streams-deleteStreamProcessor.txt @@ -12,7 +12,10 @@ atlas api streams deleteStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Delete a Stream Processor within the specified stream instance. +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. + +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 85eb58ae4a..cde2890556 100644 --- a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt @@ -12,7 +12,10 @@ atlas api streams deleteVpcPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Deletes an incoming VPC Peering connection. +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. + +Deletes an incoming VPC Peering connection. This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteVpcPeeringConnection. diff --git a/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt b/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt index d41d62b109..5eec8f71c2 100644 --- a/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt +++ b/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt @@ -12,7 +12,10 @@ atlas api streams downloadStreamTenantAuditLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Downloads the audit logs for the specified Atlas Streams Processing instance. +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. + +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 7ffce7cadc..31f8c185ba 100644 --- a/docs/command/atlas-api-streams-getAccountDetails.txt +++ b/docs/command/atlas-api-streams-getAccountDetails.txt @@ -12,7 +12,10 @@ atlas api streams getAccountDetails :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the Account ID, and the VPC ID for the group and region specified. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getAccountDetails. diff --git a/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt index 026edf54b2..d452ea41c5 100644 --- a/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt +++ b/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt @@ -12,7 +12,10 @@ atlas api streams getActiveVpcPeeringConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of active incoming VPC Peering Connections. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getActiveVpcPeeringConnections. diff --git a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt index 5003052686..aff69bd2e3 100644 --- a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt @@ -12,7 +12,10 @@ atlas api streams getPrivateLinkConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one Private Link connection within the project. +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. + +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 e9f6bca730..b3e9a2c342 100644 --- a/docs/command/atlas-api-streams-getStreamConnection.txt +++ b/docs/command/atlas-api-streams-getStreamConnection.txt @@ -12,7 +12,10 @@ atlas api streams getStreamConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one stream connection within the specified stream instance. +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. + +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 f45429b7a8..e68327ff87 100644 --- a/docs/command/atlas-api-streams-getStreamInstance.txt +++ b/docs/command/atlas-api-streams-getStreamInstance.txt @@ -12,7 +12,10 @@ atlas api streams getStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the details of one stream instance within the specified project. +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. + +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 52f5fac9ee..79fd275389 100644 --- a/docs/command/atlas-api-streams-getStreamProcessor.txt +++ b/docs/command/atlas-api-streams-getStreamProcessor.txt @@ -12,7 +12,10 @@ atlas api streams getStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Get one Stream Processor within the specified stream instance. +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. + +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 6e11224132..a61eb5b5a3 100644 --- a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt +++ b/docs/command/atlas-api-streams-getVpcPeeringConnections.txt @@ -12,7 +12,10 @@ atlas api streams getVpcPeeringConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns a list of incoming VPC Peering Connections. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getVpcPeeringConnections. diff --git a/docs/command/atlas-api-streams-listPrivateLinkConnections.txt b/docs/command/atlas-api-streams-listPrivateLinkConnections.txt index 19ae055928..a82ac2dbcf 100644 --- a/docs/command/atlas-api-streams-listPrivateLinkConnections.txt +++ b/docs/command/atlas-api-streams-listPrivateLinkConnections.txt @@ -12,7 +12,10 @@ atlas api streams listPrivateLinkConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Private Link connections for the specified project. +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. + +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 2c70fffc14..136fbd7e18 100644 --- a/docs/command/atlas-api-streams-listStreamConnections.txt +++ b/docs/command/atlas-api-streams-listStreamConnections.txt @@ -12,7 +12,10 @@ atlas api streams listStreamConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all connections of the stream instance for the specified project. +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. + +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 7fb6bf3c1e..39ad3cb5cf 100644 --- a/docs/command/atlas-api-streams-listStreamInstances.txt +++ b/docs/command/atlas-api-streams-listStreamInstances.txt @@ -12,7 +12,10 @@ atlas api streams listStreamInstances :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all stream instances for the specified project. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamInstances. diff --git a/docs/command/atlas-api-streams-listStreamProcessors.txt b/docs/command/atlas-api-streams-listStreamProcessors.txt index 7a066cea53..b0873096c8 100644 --- a/docs/command/atlas-api-streams-listStreamProcessors.txt +++ b/docs/command/atlas-api-streams-listStreamProcessors.txt @@ -12,7 +12,10 @@ atlas api streams listStreamProcessors :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all Stream Processors within the specified stream instance. +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. + +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 78dff3fa2c..bdfad90c5b 100644 --- a/docs/command/atlas-api-streams-modifyStreamProcessor.txt +++ b/docs/command/atlas-api-streams-modifyStreamProcessor.txt @@ -12,7 +12,10 @@ atlas api streams modifyStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Modify one existing Stream Processor within the specified stream instance. +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. + +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 f75a4a3025..de635dddb0 100644 --- a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt @@ -12,7 +12,10 @@ atlas api streams rejectVpcPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Requests the rejection of an incoming VPC Peering connection. +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. + +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/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/rejectVpcPeeringConnection. diff --git a/docs/command/atlas-api-streams-startStreamProcessor.txt b/docs/command/atlas-api-streams-startStreamProcessor.txt index 5282a9cec6..839cbc51c8 100644 --- a/docs/command/atlas-api-streams-startStreamProcessor.txt +++ b/docs/command/atlas-api-streams-startStreamProcessor.txt @@ -12,7 +12,10 @@ atlas api streams startStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Start a Stream Processor within the specified stream instance. +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. + +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 c97ebff62b..e0832e15a5 100644 --- a/docs/command/atlas-api-streams-startStreamProcessorWith.txt +++ b/docs/command/atlas-api-streams-startStreamProcessorWith.txt @@ -12,7 +12,10 @@ atlas api streams startStreamProcessorWith :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Start a Stream Processor within the specified stream instance. +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. + +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 d773623249..49dc7bc120 100644 --- a/docs/command/atlas-api-streams-stopStreamProcessor.txt +++ b/docs/command/atlas-api-streams-stopStreamProcessor.txt @@ -12,7 +12,10 @@ atlas api streams stopStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Stop a Stream Processor within the specified stream instance. +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. + +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 b641b913d9..8944074673 100644 --- a/docs/command/atlas-api-streams-updateStreamConnection.txt +++ b/docs/command/atlas-api-streams-updateStreamConnection.txt @@ -12,7 +12,10 @@ atlas api streams updateStreamConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Update one connection for the specified stream instance in the specified project. +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. + +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 d670acf851..d7326e23da 100644 --- a/docs/command/atlas-api-streams-updateStreamInstance.txt +++ b/docs/command/atlas-api-streams-updateStreamInstance.txt @@ -12,7 +12,10 @@ atlas api streams updateStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Update one stream instance in the specified project. +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. + +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 105ab49384..d5c2197426 100644 --- a/docs/command/atlas-api-streams.txt +++ b/docs/command/atlas-api-streams.txt @@ -12,7 +12,10 @@ atlas api streams :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes Streams Instances. +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. + +Returns, adds, edits, and removes Streams Instances. This resource requires your project ID. @@ -51,36 +54,126 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-streams-acceptVpcPeeringConnection` - `Public Preview: please provide feedback at `_: Requests the acceptance of an incoming VPC Peering connection. -* :ref:`atlas-api-streams-createPrivateLinkConnection` - `Public Preview: please provide feedback at `_: Creates one Private Link in the specified project. -* :ref:`atlas-api-streams-createStreamConnection` - `Public Preview: please provide feedback at `_: Creates one connection for a stream instance in the specified project. -* :ref:`atlas-api-streams-createStreamInstance` - `Public Preview: please provide feedback at `_: Creates one stream instance in the specified project. -* :ref:`atlas-api-streams-createStreamInstanceWithSampleConnections` - `Public Preview: please provide feedback at `_: Creates one stream instance in the specified project with sample connections. -* :ref:`atlas-api-streams-createStreamProcessor` - `Public Preview: please provide feedback at `_: Create one Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-deletePrivateLinkConnection` - `Public Preview: please provide feedback at `_: Deletes one Private Link in the specified project. -* :ref:`atlas-api-streams-deleteStreamConnection` - `Public Preview: please provide feedback at `_: Delete one connection of the specified stream instance. -* :ref:`atlas-api-streams-deleteStreamInstance` - `Public Preview: please provide feedback at `_: Delete one stream instance in the specified project. -* :ref:`atlas-api-streams-deleteStreamProcessor` - `Public Preview: please provide feedback at `_: Delete a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-deleteVpcPeeringConnection` - `Public Preview: please provide feedback at `_: Deletes an incoming VPC Peering connection. -* :ref:`atlas-api-streams-downloadStreamTenantAuditLogs` - `Public Preview: please provide feedback at `_: Downloads the audit logs for the specified Atlas Streams Processing instance. -* :ref:`atlas-api-streams-getAccountDetails` - `Public Preview: please provide feedback at `_: Returns the Account ID, and the VPC ID for the group and region specified. -* :ref:`atlas-api-streams-getActiveVpcPeeringConnections` - `Public Preview: please provide feedback at `_: Returns a list of active incoming VPC Peering Connections. -* :ref:`atlas-api-streams-getPrivateLinkConnection` - `Public Preview: please provide feedback at `_: Returns the details of one Private Link connection within the project. -* :ref:`atlas-api-streams-getStreamConnection` - `Public Preview: please provide feedback at `_: Returns the details of one stream connection within the specified stream instance. -* :ref:`atlas-api-streams-getStreamInstance` - `Public Preview: please provide feedback at `_: Returns the details of one stream instance within the specified project. -* :ref:`atlas-api-streams-getStreamProcessor` - `Public Preview: please provide feedback at `_: Get one Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-getVpcPeeringConnections` - `Public Preview: please provide feedback at `_: Returns a list of incoming VPC Peering Connections. -* :ref:`atlas-api-streams-listPrivateLinkConnections` - `Public Preview: please provide feedback at `_: Returns all Private Link connections for the specified project. -* :ref:`atlas-api-streams-listStreamConnections` - `Public Preview: please provide feedback at `_: Returns all connections of the stream instance for the specified project. -* :ref:`atlas-api-streams-listStreamInstances` - `Public Preview: please provide feedback at `_: Returns all stream instances for the specified project. -* :ref:`atlas-api-streams-listStreamProcessors` - `Public Preview: please provide feedback at `_: Returns all Stream Processors within the specified stream instance. -* :ref:`atlas-api-streams-modifyStreamProcessor` - `Public Preview: please provide feedback at `_: Modify one existing Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-rejectVpcPeeringConnection` - `Public Preview: please provide feedback at `_: Requests the rejection of an incoming VPC Peering connection. -* :ref:`atlas-api-streams-startStreamProcessor` - `Public Preview: please provide feedback at `_: Start a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-startStreamProcessorWith` - `Public Preview: please provide feedback at `_: Start a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-stopStreamProcessor` - `Public Preview: please provide feedback at `_: Stop a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-updateStreamConnection` - `Public Preview: please provide feedback at `_: Update one connection for the specified stream instance in the specified project. -* :ref:`atlas-api-streams-updateStreamInstance` - `Public Preview: please provide feedback at `_: Update one stream instance in the specified project. +* :ref:`atlas-api-streams-acceptVpcPeeringConnection` - 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. + +Requests the acceptance of an incoming VPC Peering connection. +* :ref:`atlas-api-streams-createPrivateLinkConnection` - 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. + +Creates one Private Link in the specified project. +* :ref:`atlas-api-streams-createStreamConnection` - 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. + +Creates one connection for a stream instance in the specified project. +* :ref:`atlas-api-streams-createStreamInstance` - 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. + +Creates one stream instance in the specified project. +* :ref:`atlas-api-streams-createStreamInstanceWithSampleConnections` - 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. + +Creates one stream instance in the specified project with sample connections. +* :ref:`atlas-api-streams-createStreamProcessor` - 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. + +Create one Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-deletePrivateLinkConnection` - 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. + +Deletes one Private Link in the specified project. +* :ref:`atlas-api-streams-deleteStreamConnection` - 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. + +Delete one connection of the specified stream instance. +* :ref:`atlas-api-streams-deleteStreamInstance` - 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. + +Delete one stream instance in the specified project. +* :ref:`atlas-api-streams-deleteStreamProcessor` - 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. + +Delete a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-deleteVpcPeeringConnection` - 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. + +Deletes an incoming VPC Peering connection. +* :ref:`atlas-api-streams-downloadStreamTenantAuditLogs` - 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. + +Downloads the audit logs for the specified Atlas Streams Processing instance. +* :ref:`atlas-api-streams-getAccountDetails` - 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. + +Returns the Account ID, and the VPC ID for the group and region specified. +* :ref:`atlas-api-streams-getActiveVpcPeeringConnections` - 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. + +Returns a list of active incoming VPC Peering Connections. +* :ref:`atlas-api-streams-getPrivateLinkConnection` - 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. + +Returns the details of one Private Link connection within the project. +* :ref:`atlas-api-streams-getStreamConnection` - 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. + +Returns the details of one stream connection within the specified stream instance. +* :ref:`atlas-api-streams-getStreamInstance` - 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. + +Returns the details of one stream instance within the specified project. +* :ref:`atlas-api-streams-getStreamProcessor` - 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. + +Get one Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-getVpcPeeringConnections` - 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. + +Returns a list of incoming VPC Peering Connections. +* :ref:`atlas-api-streams-listPrivateLinkConnections` - 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. + +Returns all Private Link connections for the specified project. +* :ref:`atlas-api-streams-listStreamConnections` - 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. + +Returns all connections of the stream instance for the specified project. +* :ref:`atlas-api-streams-listStreamInstances` - 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. + +Returns all stream instances for the specified project. +* :ref:`atlas-api-streams-listStreamProcessors` - 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. + +Returns all Stream Processors within the specified stream instance. +* :ref:`atlas-api-streams-modifyStreamProcessor` - 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. + +Modify one existing Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-rejectVpcPeeringConnection` - 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. + +Requests the rejection of an incoming VPC Peering connection. +* :ref:`atlas-api-streams-startStreamProcessor` - 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. + +Start a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-startStreamProcessorWith` - 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. + +Start a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-stopStreamProcessor` - 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. + +Stop a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-updateStreamConnection` - 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. + +Update one connection for the specified stream instance in the specified project. +* :ref:`atlas-api-streams-updateStreamInstance` - 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. + +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 abbc5fcd01..98a43935df 100644 --- a/docs/command/atlas-api-teams-addAllTeamsToProject.txt +++ b/docs/command/atlas-api-teams-addAllTeamsToProject.txt @@ -12,7 +12,10 @@ atlas api teams addAllTeamsToProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one or more teams to the specified project. +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. + +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 623c36d7e9..8ed4205af6 100644 --- a/docs/command/atlas-api-teams-addTeamUser.txt +++ b/docs/command/atlas-api-teams-addTeamUser.txt @@ -12,7 +12,10 @@ atlas api teams addTeamUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds one or more MongoDB Cloud users from the specified organization to the specified team. +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. + +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 cb4e7fa9ef..fbd4066368 100644 --- a/docs/command/atlas-api-teams-createTeam.txt +++ b/docs/command/atlas-api-teams-createTeam.txt @@ -12,7 +12,10 @@ atlas api teams createTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Creates one team in the specified organization. +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. + +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 e29ea0f8e4..ac40075a87 100644 --- a/docs/command/atlas-api-teams-deleteTeam.txt +++ b/docs/command/atlas-api-teams-deleteTeam.txt @@ -12,7 +12,10 @@ atlas api teams deleteTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. +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. + +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-getTeamById.txt b/docs/command/atlas-api-teams-getTeamById.txt index 0ec43247c1..1881f71273 100644 --- a/docs/command/atlas-api-teams-getTeamById.txt +++ b/docs/command/atlas-api-teams-getTeamById.txt @@ -12,7 +12,10 @@ atlas api teams getTeamById :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one team that you identified using its unique 24-hexadecimal digit ID. +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. + +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 e4ace954e2..c447e2a24b 100644 --- a/docs/command/atlas-api-teams-getTeamByName.txt +++ b/docs/command/atlas-api-teams-getTeamByName.txt @@ -12,7 +12,10 @@ atlas api teams getTeamByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns one team that you identified using its human-readable name. +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. + +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 73bb2d7593..7f3f1658e5 100644 --- a/docs/command/atlas-api-teams-listOrganizationTeams.txt +++ b/docs/command/atlas-api-teams-listOrganizationTeams.txt @@ -12,7 +12,10 @@ atlas api teams listOrganizationTeams :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all teams that belong to the specified organization. +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. + +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 8a3c0e3c80..ab9cbb9580 100644 --- a/docs/command/atlas-api-teams-listProjectTeams.txt +++ b/docs/command/atlas-api-teams-listProjectTeams.txt @@ -12,7 +12,10 @@ atlas api teams listProjectTeams :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. +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. + +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 b2e9495200..d1dd06c89b 100644 --- a/docs/command/atlas-api-teams-removeProjectTeam.txt +++ b/docs/command/atlas-api-teams-removeProjectTeam.txt @@ -12,7 +12,10 @@ atlas api teams removeProjectTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. +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. + +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 7e3c26bd40..169739bebf 100644 --- a/docs/command/atlas-api-teams-removeTeamUser.txt +++ b/docs/command/atlas-api-teams-removeTeamUser.txt @@ -12,7 +12,10 @@ atlas api teams removeTeamUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes one MongoDB Cloud user from the specified team. +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. + +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 710a441c5a..d7ca588138 100644 --- a/docs/command/atlas-api-teams-renameTeam.txt +++ b/docs/command/atlas-api-teams-renameTeam.txt @@ -12,7 +12,10 @@ atlas api teams renameTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Renames one team in the specified organization. +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. + +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 03ecaa7caf..5a8e281679 100644 --- a/docs/command/atlas-api-teams-updateTeamRoles.txt +++ b/docs/command/atlas-api-teams-updateTeamRoles.txt @@ -12,7 +12,10 @@ atlas api teams updateTeamRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the project roles assigned to the specified team. +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. + +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 5ade5ffa12..5cf55cee39 100644 --- a/docs/command/atlas-api-teams.txt +++ b/docs/command/atlas-api-teams.txt @@ -12,7 +12,10 @@ atlas api teams :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, or removes teams. +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. + +Returns, adds, edits, or removes teams. Options ------- @@ -49,18 +52,54 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-teams-addAllTeamsToProject` - `Public Preview: please provide feedback at `_: Adds one or more teams to the specified project. -* :ref:`atlas-api-teams-addTeamUser` - `Public Preview: please provide feedback at `_: 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 at `_: Creates one team in the specified organization. -* :ref:`atlas-api-teams-deleteTeam` - `Public Preview: please provide feedback at `_: 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-getTeamById` - `Public Preview: please provide feedback at `_: Returns one team that you identified using its unique 24-hexadecimal digit ID. -* :ref:`atlas-api-teams-getTeamByName` - `Public Preview: please provide feedback at `_: Returns one team that you identified using its human-readable name. -* :ref:`atlas-api-teams-listOrganizationTeams` - `Public Preview: please provide feedback at `_: Returns all teams that belong to the specified organization. -* :ref:`atlas-api-teams-listProjectTeams` - `Public Preview: please provide feedback at `_: 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 at `_: 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 at `_: Removes one MongoDB Cloud user from the specified team. -* :ref:`atlas-api-teams-renameTeam` - `Public Preview: please provide feedback at `_: Renames one team in the specified organization. -* :ref:`atlas-api-teams-updateTeamRoles` - `Public Preview: please provide feedback at `_: Updates the project roles assigned to the specified team. +* :ref:`atlas-api-teams-addAllTeamsToProject` - 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. + +Adds one or more teams to the specified project. +* :ref:`atlas-api-teams-addTeamUser` - 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. + +Adds one or more MongoDB Cloud users from the specified organization to the specified team. +* :ref:`atlas-api-teams-createTeam` - 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. + +Creates one team in the specified organization. +* :ref:`atlas-api-teams-deleteTeam` - 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. + +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-getTeamById` - 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. + +Returns one team that you identified using its unique 24-hexadecimal digit ID. +* :ref:`atlas-api-teams-getTeamByName` - 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. + +Returns one team that you identified using its human-readable name. +* :ref:`atlas-api-teams-listOrganizationTeams` - 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. + +Returns all teams that belong to the specified organization. +* :ref:`atlas-api-teams-listProjectTeams` - 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. + +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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +* :ref:`atlas-api-teams-removeTeamUser` - 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. + +Removes one MongoDB Cloud user from the specified team. +* :ref:`atlas-api-teams-renameTeam` - 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. + +Renames one team in the specified organization. +* :ref:`atlas-api-teams-updateTeamRoles` - 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. + +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 a63a49d673..7ec37190f7 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt @@ -12,7 +12,10 @@ atlas api thirdPartyIntegrations createThirdPartyIntegration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Adds the settings for configuring one third-party service integration. +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. + +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 029b720bb5..a1e6649041 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt @@ -12,7 +12,10 @@ atlas api thirdPartyIntegrations deleteThirdPartyIntegration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Removes the settings that permit configuring one third-party service integration. +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. + +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 633ffabf43..22cb044ada 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt @@ -12,7 +12,10 @@ atlas api thirdPartyIntegrations getThirdPartyIntegration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the settings for configuring integration with one third-party service. +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. + +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 47cb1025b1..acdfda7e9e 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt @@ -12,7 +12,10 @@ atlas api thirdPartyIntegrations listThirdPartyIntegrations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns the settings that permit integrations with all configured third-party services. +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. + +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 349ec18453..1aba874c36 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt @@ -12,7 +12,10 @@ atlas api thirdPartyIntegrations updateThirdPartyIntegration :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Updates the settings for configuring integration with one third-party service. +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. + +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 6aa78d9c47..d92885f66b 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations.txt @@ -12,7 +12,10 @@ atlas api thirdPartyIntegrations :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, adds, edits, and removes third-party service integration configurations. +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. + +Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure. @@ -54,11 +57,26 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-thirdPartyIntegrations-createThirdPartyIntegration` - `Public Preview: please provide feedback at `_: Adds the settings for configuring one third-party service integration. -* :ref:`atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration` - `Public Preview: please provide feedback at `_: Removes the settings that permit configuring one third-party service integration. -* :ref:`atlas-api-thirdPartyIntegrations-getThirdPartyIntegration` - `Public Preview: please provide feedback at `_: Returns the settings for configuring integration with one third-party service. -* :ref:`atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations` - `Public Preview: please provide feedback at `_: Returns the settings that permit integrations with all configured third-party services. -* :ref:`atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration` - `Public Preview: please provide feedback at `_: Updates the settings for configuring integration with one third-party service. +* :ref:`atlas-api-thirdPartyIntegrations-createThirdPartyIntegration` - 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. + +Adds the settings for configuring one third-party service integration. +* :ref:`atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration` - 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. + +Removes the settings that permit configuring one third-party service integration. +* :ref:`atlas-api-thirdPartyIntegrations-getThirdPartyIntegration` - 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. + +Returns the settings for configuring integration with one third-party service. +* :ref:`atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations` - 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. + +Returns the settings that permit integrations with all configured third-party services. +* :ref:`atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration` - 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. + +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 a33c0e8e0b..4bcd2ede50 100644 --- a/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt +++ b/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt @@ -12,7 +12,10 @@ atlas api x509Authentication createDatabaseUserCertificate :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Generates one X.509 certificate for the specified MongoDB user. +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. + +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 f5977c8052..4fa4faa8d5 100644 --- a/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt +++ b/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt @@ -12,7 +12,10 @@ atlas api x509Authentication disableCustomerManagedX509 :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. +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. + +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 80a0347146..7671f55af7 100644 --- a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt +++ b/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt @@ -12,7 +12,10 @@ atlas api x509Authentication listDatabaseUserCertificates :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns all unexpired X.509 certificates for the specified MongoDB user. +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. + +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 c7d7027685..693c2fd3bb 100644 --- a/docs/command/atlas-api-x509Authentication.txt +++ b/docs/command/atlas-api-x509Authentication.txt @@ -12,7 +12,10 @@ atlas api x509Authentication :depth: 1 :class: singlecol -`Public Preview: please provide feedback at `_: Returns, edits, and removes user-managed X.509 configurations. +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. + +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. @@ -51,9 +54,18 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-x509Authentication-createDatabaseUserCertificate` - `Public Preview: please provide feedback at `_: Generates one X.509 certificate for the specified MongoDB user. -* :ref:`atlas-api-x509Authentication-disableCustomerManagedX509` - `Public Preview: please provide feedback at `_: 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 at `_: Returns all unexpired X.509 certificates for the specified MongoDB user. +* :ref:`atlas-api-x509Authentication-createDatabaseUserCertificate` - 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. + +Generates one X.509 certificate for the specified MongoDB user. +* :ref:`atlas-api-x509Authentication-disableCustomerManagedX509` - 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. + +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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. .. toctree:: diff --git a/docs/command/atlas-api.txt b/docs/command/atlas-api.txt index 8162372064..63a60454ac 100644 --- a/docs/command/atlas-api.txt +++ b/docs/command/atlas-api.txt @@ -12,7 +12,7 @@ atlas api :depth: 1 :class: singlecol -Public Preview: please provide feedback at : 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. @@ -20,8 +20,8 @@ For more information on - Atlas Administration API see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/ - Getting started with the Atlas Administration API: https://www.mongodb.com/docs/atlas/configure-api-access/#std-label-atlas-admin-api-access -This feature in public preview streamlines script development by letting you interact -directly with any Atlas Administration API endpoint by using the Atlas CLI. +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 ------ @@ -138,6 +138,7 @@ In addition, the following options are available for all Atlas Administration AP - false - Help for the current command. + Options ------- @@ -173,56 +174,206 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-accessTracking` - `Public Preview: please provide feedback at `_: Returns access logs for authentication attempts made to Atlas database deployments. -* :ref:`atlas-api-alertConfigurations` - `Public Preview: please provide feedback at `_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. -* :ref:`atlas-api-alerts` - `Public Preview: please provide feedback at `_: 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 at `_: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. -* :ref:`atlas-api-auditing` - `Public Preview: please provide feedback at `_: Returns and edits database auditing settings for MongoDB Cloud projects. -* :ref:`atlas-api-awsClustersDns` - `Public Preview: please provide feedback at `_: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. -* :ref:`atlas-api-cloudBackups` - `Public Preview: please provide feedback at `_: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. -* :ref:`atlas-api-cloudMigrationService` - `Public Preview: please provide feedback at `_: Manages the Cloud Migration Service. -* :ref:`atlas-api-cloudProviderAccess` - `Public Preview: please provide feedback at `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. -* :ref:`atlas-api-clusterOutageSimulation` - `Public Preview: please provide feedback at `_: Returns, starts, or ends a cluster outage simulation. -* :ref:`atlas-api-clusters` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes database deployments. -* :ref:`atlas-api-collectionLevelMetrics` - `Public Preview: please provide feedback at `_: Returns, adds, and edits pinned namespaces for the specified cluster or process. -* :ref:`atlas-api-customDatabaseRoles` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes custom database user privilege roles. -* :ref:`atlas-api-dataFederation` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes Federated Database Instances. -* :ref:`atlas-api-dataLakePipelines` - `Public Preview: please provide feedback at `_: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. -* :ref:`atlas-api-databaseUsers` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes database users. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement` - `Public Preview: please provide feedback at `_: Returns and edits the Encryption at Rest using Customer Key Management configuration. -* :ref:`atlas-api-events` - `Public Preview: please provide feedback at `_: Returns events. -* :ref:`atlas-api-federatedAuthentication` - `Public Preview: please provide feedback at `_: 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 at `_: Returns, adds, edits, and removes flex clusters. -* :ref:`atlas-api-flexRestoreJobs` - `Public Preview: please provide feedback at `_: Returns and adds restore jobs for flex database deployments. -* :ref:`atlas-api-flexSnapshots` - `Public Preview: please provide feedback at `_: Returns and requests to download flex database deployment snapshots. -* :ref:`atlas-api-globalClusters` - `Public Preview: please provide feedback at `_: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. -* :ref:`atlas-api-invoices` - `Public Preview: please provide feedback at `_: Returns invoices. -* :ref:`atlas-api-ldapConfiguration` - `Public Preview: please provide feedback at `_: Returns, edits, verifies, and removes LDAP configurations. -* :ref:`atlas-api-legacyBackup` - `Public Preview: please provide feedback at `_: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. -* :ref:`atlas-api-maintenanceWindows` - `Public Preview: please provide feedback at `_: Returns, edits, and removes maintenance windows. -* :ref:`atlas-api-mongoDbCloudUsers` - `Public Preview: please provide feedback at `_: Returns, adds, and edits MongoDB Cloud users. -* :ref:`atlas-api-monitoringAndLogs` - `Public Preview: please provide feedback at `_: Returns database deployment monitoring and logging data. -* :ref:`atlas-api-networkPeering` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes network peering containers and peering connections. -* :ref:`atlas-api-onlineArchive` - `Public Preview: please provide feedback at `_: Returns, adds, edits, or removes an online archive. -* :ref:`atlas-api-organizations` - `Public Preview: please provide feedback at `_: Returns, adds, and edits organizational units in MongoDB Cloud. -* :ref:`atlas-api-performanceAdvisor` - `Public Preview: please provide feedback at `_: Returns suggested indexes and slow query data for a database deployment. -* :ref:`atlas-api-privateEndpointServices` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes private endpoint services. -* :ref:`atlas-api-programmaticApiKeys` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. -* :ref:`atlas-api-projectIpAccessList` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes network access limits to database deployments in Atlas. -* :ref:`atlas-api-projects` - `Public Preview: please provide feedback at `_: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. -* :ref:`atlas-api-pushBasedLogExport` - `Public Preview: please provide feedback at `_: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. -* :ref:`atlas-api-resourcePolicies` - `Public Preview: please provide feedback at `_: Configure and manage Atlas Resource Policies within your organization. -* :ref:`atlas-api-rollingIndex` - `Public Preview: please provide feedback at `_: Creates one index to a database deployment in a rolling manner. -* :ref:`atlas-api-root` - `Public Preview: please provide feedback at `_: 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 at `_: Returns, adds, edits, and removes serverless instances. -* :ref:`atlas-api-serverlessPrivateEndpoints` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes private endpoints for serverless instances. -* :ref:`atlas-api-serviceAccounts` - `Public Preview: please provide feedback at `_: Endpoints for managing Service Accounts and secrets. -* :ref:`atlas-api-sharedTierRestoreJobs` - `Public Preview: please provide feedback at `_: Returns and adds restore jobs for shared-tier database deployments. -* :ref:`atlas-api-sharedTierSnapshots` - `Public Preview: please provide feedback at `_: Returns and requests to download shared-tier database deployment snapshots. -* :ref:`atlas-api-streams` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes Streams Instances. -* :ref:`atlas-api-teams` - `Public Preview: please provide feedback at `_: Returns, adds, edits, or removes teams. -* :ref:`atlas-api-thirdPartyIntegrations` - `Public Preview: please provide feedback at `_: Returns, adds, edits, and removes third-party service integration configurations. -* :ref:`atlas-api-x509Authentication` - `Public Preview: please provide feedback at `_: Returns, edits, and removes user-managed X.509 configurations. +* :ref:`atlas-api-accessTracking` - 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. + +Returns access logs for authentication attempts made to Atlas database deployments. +* :ref:`atlas-api-alertConfigurations` - 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. + +Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. +* :ref:`atlas-api-alerts` - 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. + +Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. +* :ref:`atlas-api-atlasSearch` - 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. + +Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. +* :ref:`atlas-api-auditing` - 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. + +Returns and edits database auditing settings for MongoDB Cloud projects. +* :ref:`atlas-api-awsClustersDns` - 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. + +Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. +* :ref:`atlas-api-cloudBackups` - 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. + +Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. +* :ref:`atlas-api-cloudMigrationService` - 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. + +Manages the Cloud Migration Service. +* :ref:`atlas-api-cloudProviderAccess` - 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. + +Returns, adds, authorizes, and removes AWS IAM roles in Atlas. +* :ref:`atlas-api-clusterOutageSimulation` - 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. + +Returns, starts, or ends a cluster outage simulation. +* :ref:`atlas-api-clusters` - 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. + +Returns, adds, edits, and removes database deployments. +* :ref:`atlas-api-collectionLevelMetrics` - 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. + +Returns, adds, and edits pinned namespaces for the specified cluster or process. +* :ref:`atlas-api-customDatabaseRoles` - 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. + +Returns, adds, edits, and removes custom database user privilege roles. +* :ref:`atlas-api-dataFederation` - 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. + +Returns, adds, edits, and removes Federated Database Instances. +* :ref:`atlas-api-dataLakePipelines` - 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. + +Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. +* :ref:`atlas-api-databaseUsers` - 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. + +Returns, adds, edits, and removes database users. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement` - 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. + +Returns and edits the Encryption at Rest using Customer Key Management configuration. +* :ref:`atlas-api-events` - 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. + +Returns events. +* :ref:`atlas-api-federatedAuthentication` - 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. + +Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. +* :ref:`atlas-api-flexClusters` - 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. + +Returns, adds, edits, and removes flex clusters. +* :ref:`atlas-api-flexRestoreJobs` - 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. + +Returns and adds restore jobs for flex database deployments. +* :ref:`atlas-api-flexSnapshots` - 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. + +Returns and requests to download flex database deployment snapshots. +* :ref:`atlas-api-globalClusters` - 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. + +Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. +* :ref:`atlas-api-invoices` - 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. + +Returns invoices. +* :ref:`atlas-api-ldapConfiguration` - 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. + +Returns, edits, verifies, and removes LDAP configurations. +* :ref:`atlas-api-legacyBackup` - 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. + +Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. +* :ref:`atlas-api-maintenanceWindows` - 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. + +Returns, edits, and removes maintenance windows. +* :ref:`atlas-api-mongoDbCloudUsers` - 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. + +Returns, adds, and edits MongoDB Cloud users. +* :ref:`atlas-api-monitoringAndLogs` - 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. + +Returns database deployment monitoring and logging data. +* :ref:`atlas-api-networkPeering` - 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. + +Returns, adds, edits, and removes network peering containers and peering connections. +* :ref:`atlas-api-onlineArchive` - 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. + +Returns, adds, edits, or removes an online archive. +* :ref:`atlas-api-organizations` - 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. + +Returns, adds, and edits organizational units in MongoDB Cloud. +* :ref:`atlas-api-performanceAdvisor` - 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. + +Returns suggested indexes and slow query data for a database deployment. +* :ref:`atlas-api-privateEndpointServices` - 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. + +Returns, adds, edits, and removes private endpoint services. +* :ref:`atlas-api-programmaticApiKeys` - 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. + +Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. +* :ref:`atlas-api-projectIpAccessList` - 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. + +Returns, adds, edits, and removes network access limits to database deployments in Atlas. +* :ref:`atlas-api-projects` - 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. + +Returns, adds, and edits collections of clusters and users in MongoDB Cloud. +* :ref:`atlas-api-pushBasedLogExport` - 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. + +You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. +* :ref:`atlas-api-resourcePolicies` - 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. + +Configure and manage Atlas Resource Policies within your organization. +* :ref:`atlas-api-rollingIndex` - 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. + +Creates one index to a database deployment in a rolling manner. +* :ref:`atlas-api-root` - 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. + +Returns details that describe the MongoDB Cloud build and the access token that requests this resource. +* :ref:`atlas-api-serverlessInstances` - 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. + +Returns, adds, edits, and removes serverless instances. +* :ref:`atlas-api-serverlessPrivateEndpoints` - 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. + +Returns, adds, edits, and removes private endpoints for serverless instances. +* :ref:`atlas-api-serviceAccounts` - 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. + +Endpoints for managing Service Accounts and secrets. +* :ref:`atlas-api-sharedTierRestoreJobs` - 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. + +Returns and adds restore jobs for shared-tier database deployments. +* :ref:`atlas-api-sharedTierSnapshots` - 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. + +Returns and requests to download shared-tier database deployment snapshots. +* :ref:`atlas-api-streams` - 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. + +Returns, adds, edits, and removes Streams Instances. +* :ref:`atlas-api-teams` - 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. + +Returns, adds, edits, or removes teams. +* :ref:`atlas-api-thirdPartyIntegrations` - 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. + +Returns, adds, edits, and removes third-party service integration configurations. +* :ref:`atlas-api-x509Authentication` - 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. + +Returns, edits, and removes user-managed X.509 configurations. .. toctree:: diff --git a/docs/command/atlas.txt b/docs/command/atlas.txt index f6ab91e6a5..494fe95004 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 at : 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. diff --git a/internal/cli/api/api.go b/internal/cli/api/api.go index 026d17da99..6cc3bdfd83 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: `Public Preview: please provide feedback at : 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 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. For more information on diff --git a/internal/cli/help_templates.go b/internal/cli/help_templates.go index 7ccc350043..b44501d8ab 100644 --- a/internal/cli/help_templates.go +++ b/internal/cli/help_templates.go @@ -15,11 +15,18 @@ package cli const ( - // Help template + // HelpTemplate // Modified version of https://github.com/spf13/cobra/blob/01ffff4eca5a08384ef2b85f39ec0dac192a5f7b/command.go#L595 which shows both .Short and .Long help descriptions. HelpTemplate = `{{.Short | trimTrailingWhitespaces}} {{.Long | trimTrailingWhitespaces}} {{if or .Runnable .HasSubCommands}}{{.UsageString}}{{end}}` - ExperimentalHelpTemplate = "Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli.\n\n" + HelpTemplate + ExperimentalText = "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).\n" + + "Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint " + + "documentation link.\n\n" + + ExperimentalHelpTemplate = ExperimentalText + HelpTemplate ) diff --git a/tools/cmd/docs/api_docs_long_text.txt b/tools/cmd/docs/api_docs_long_text.txt index 72b7bde10a..437e048461 100644 --- a/tools/cmd/docs/api_docs_long_text.txt +++ b/tools/cmd/docs/api_docs_long_text.txt @@ -1,5 +1,5 @@ -This feature in public preview streamlines script development by letting you interact -directly with any Atlas Administration API endpoint by using the Atlas CLI. +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 ------ @@ -114,4 +114,4 @@ In addition, the following options are available for all Atlas Administration AP * - ``-h, --help`` - boolean - false - - Help for the current command. \ No newline at end of file + - Help for the current command. diff --git a/tools/cmd/docs/transformations.go b/tools/cmd/docs/transformations.go index f3db029b52..01a6f29026 100644 --- a/tools/cmd/docs/transformations.go +++ b/tools/cmd/docs/transformations.go @@ -22,6 +22,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" @@ -58,7 +59,7 @@ func markExperimentalToAPICommands(cmd *cobra.Command) { if cmd.CommandPath() == "atlas api" { return // Skip the root command } - cmd.Short = "`Public Preview: please provide feedback at `_: " + cmd.Short + cmd.Short = cli.ExperimentalText + cmd.Short } func updateAPICommandDescription(cmd *cobra.Command) { From c12eb05415b7fe517bfcc1548389a6eac5a01a02 Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Fri, 23 May 2025 11:25:55 +0200 Subject: [PATCH 2/4] Update transformations.go --- docs/command/atlas-accessLists-create.txt | 5 + docs/command/atlas-accessLists-delete.txt | 5 + docs/command/atlas-accessLists-describe.txt | 5 + docs/command/atlas-accessLists-list.txt | 5 + docs/command/atlas-accessLists.txt | 7 + docs/command/atlas-accessLogs-list.txt | 5 + docs/command/atlas-accessLogs.txt | 7 + docs/command/atlas-alerts-acknowledge.txt | 5 + docs/command/atlas-alerts-describe.txt | 5 + docs/command/atlas-alerts-list.txt | 5 + docs/command/atlas-alerts-settings-create.txt | 5 + docs/command/atlas-alerts-settings-delete.txt | 5 + .../atlas-alerts-settings-describe.txt | 5 + .../command/atlas-alerts-settings-disable.txt | 7 + docs/command/atlas-alerts-settings-enable.txt | 7 + .../atlas-alerts-settings-fields-type.txt | 5 + docs/command/atlas-alerts-settings-fields.txt | 7 + docs/command/atlas-alerts-settings-list.txt | 5 + docs/command/atlas-alerts-settings-update.txt | 5 + docs/command/atlas-alerts-settings.txt | 5 + docs/command/atlas-alerts-unacknowledge.txt | 5 + docs/command/atlas-alerts.txt | 7 + ...ssTracking-listAccessLogsByClusterName.txt | 4 +- ...ccessTracking-listAccessLogsByHostname.txt | 4 +- docs/command/atlas-api-accessTracking.txt | 14 +- ...onfigurations-createAlertConfiguration.txt | 4 +- ...onfigurations-deleteAlertConfiguration.txt | 4 +- ...rtConfigurations-getAlertConfiguration.txt | 4 +- ...stAlertConfigurationMatchersFieldNames.txt | 4 +- ...Configurations-listAlertConfigurations.txt | 4 +- ...tions-listAlertConfigurationsByAlertId.txt | 4 +- ...onfigurations-toggleAlertConfiguration.txt | 4 +- ...onfigurations-updateAlertConfiguration.txt | 4 +- .../command/atlas-api-alertConfigurations.txt | 44 +-- .../atlas-api-alerts-acknowledgeAlert.txt | 4 +- docs/command/atlas-api-alerts-getAlert.txt | 4 +- docs/command/atlas-api-alerts-listAlerts.txt | 4 +- ...lerts-listAlertsByAlertConfigurationId.txt | 4 +- docs/command/atlas-api-alerts.txt | 24 +- ...tlasSearch-createAtlasSearchDeployment.txt | 4 +- ...api-atlasSearch-createAtlasSearchIndex.txt | 4 +- ...earch-createAtlasSearchIndexDeprecated.txt | 4 +- ...tlasSearch-deleteAtlasSearchDeployment.txt | 4 +- ...api-atlasSearch-deleteAtlasSearchIndex.txt | 4 +- ...lasSearch-deleteAtlasSearchIndexByName.txt | 4 +- ...earch-deleteAtlasSearchIndexDeprecated.txt | 4 +- ...i-atlasSearch-getAtlasSearchDeployment.txt | 4 +- ...as-api-atlasSearch-getAtlasSearchIndex.txt | 4 +- ...-atlasSearch-getAtlasSearchIndexByName.txt | 4 +- ...asSearch-getAtlasSearchIndexDeprecated.txt | 4 +- ...api-atlasSearch-listAtlasSearchIndexes.txt | 4 +- ...asSearch-listAtlasSearchIndexesCluster.txt | 4 +- ...earch-listAtlasSearchIndexesDeprecated.txt | 4 +- ...tlasSearch-updateAtlasSearchDeployment.txt | 4 +- ...api-atlasSearch-updateAtlasSearchIndex.txt | 4 +- ...lasSearch-updateAtlasSearchIndexByName.txt | 4 +- ...earch-updateAtlasSearchIndexDeprecated.txt | 4 +- docs/command/atlas-api-atlasSearch.txt | 94 ++----- ...-api-auditing-getAuditingConfiguration.txt | 4 +- ...i-auditing-updateAuditingConfiguration.txt | 4 +- docs/command/atlas-api-auditing.txt | 16 +- ...las-api-awsClustersDns-getAwsCustomDns.txt | 4 +- ...-api-awsClustersDns-toggleAwsCustomDns.txt | 4 +- docs/command/atlas-api-awsClustersDns.txt | 14 +- ...pi-cloudBackups-cancelBackupRestoreJob.txt | 4 +- ...api-cloudBackups-createBackupExportJob.txt | 4 +- ...pi-cloudBackups-createBackupRestoreJob.txt | 4 +- ...as-api-cloudBackups-createExportBucket.txt | 4 +- ...ckups-createServerlessBackupRestoreJob.txt | 4 +- ...-cloudBackups-deleteAllBackupSchedules.txt | 4 +- ...as-api-cloudBackups-deleteExportBucket.txt | 4 +- ...pi-cloudBackups-deleteReplicaSetBackup.txt | 4 +- ...loudBackups-deleteShardedClusterBackup.txt | 4 +- ...dBackups-disableDataProtectionSettings.txt | 4 +- ...as-api-cloudBackups-getBackupExportJob.txt | 4 +- ...s-api-cloudBackups-getBackupRestoreJob.txt | 4 +- ...las-api-cloudBackups-getBackupSchedule.txt | 4 +- ...cloudBackups-getDataProtectionSettings.txt | 4 +- ...atlas-api-cloudBackups-getExportBucket.txt | 4 +- ...s-api-cloudBackups-getReplicaSetBackup.txt | 4 +- ...s-api-cloudBackups-getServerlessBackup.txt | 4 +- ...dBackups-getServerlessBackupRestoreJob.txt | 4 +- ...i-cloudBackups-getShardedClusterBackup.txt | 4 +- ...-api-cloudBackups-listBackupExportJobs.txt | 4 +- ...api-cloudBackups-listBackupRestoreJobs.txt | 4 +- ...las-api-cloudBackups-listExportBuckets.txt | 4 +- ...api-cloudBackups-listReplicaSetBackups.txt | 4 +- ...ackups-listServerlessBackupRestoreJobs.txt | 4 +- ...api-cloudBackups-listServerlessBackups.txt | 4 +- ...cloudBackups-listShardedClusterBackups.txt | 4 +- .../atlas-api-cloudBackups-takeSnapshot.txt | 4 +- ...-api-cloudBackups-updateBackupSchedule.txt | 4 +- ...udBackups-updateDataProtectionSettings.txt | 4 +- ...i-cloudBackups-updateSnapshotRetention.txt | 4 +- docs/command/atlas-api-cloudBackups.txt | 154 +++-------- ...-cloudMigrationService-createLinkToken.txt | 4 +- ...udMigrationService-createPushMigration.txt | 4 +- ...cloudMigrationService-cutoverMigration.txt | 4 +- ...-cloudMigrationService-deleteLinkToken.txt | 4 +- ...cloudMigrationService-getPushMigration.txt | 4 +- ...udMigrationService-getValidationStatus.txt | 4 +- ...oudMigrationService-listSourceProjects.txt | 4 +- ...loudMigrationService-validateMigration.txt | 4 +- .../atlas-api-cloudMigrationService.txt | 44 +-- ...ccess-authorizeCloudProviderAccessRole.txt | 4 +- ...erAccess-createCloudProviderAccessRole.txt | 4 +- ...ess-deauthorizeCloudProviderAccessRole.txt | 4 +- ...viderAccess-getCloudProviderAccessRole.txt | 4 +- ...derAccess-listCloudProviderAccessRoles.txt | 4 +- .../command/atlas-api-cloudProviderAccess.txt | 31 +-- ...erOutageSimulation-endOutageSimulation.txt | 4 +- ...erOutageSimulation-getOutageSimulation.txt | 4 +- ...OutageSimulation-startOutageSimulation.txt | 4 +- .../atlas-api-clusterOutageSimulation.txt | 21 +- ...-api-clusters-autoScalingConfiguration.txt | 4 +- .../atlas-api-clusters-createCluster.txt | 4 +- .../atlas-api-clusters-deleteCluster.txt | 4 +- .../command/atlas-api-clusters-getCluster.txt | 4 +- ...usters-getClusterAdvancedConfiguration.txt | 4 +- .../atlas-api-clusters-getClusterStatus.txt | 4 +- ...pi-clusters-getSampleDatasetLoadStatus.txt | 4 +- ...pi-clusters-grantMongoDbEmployeeAccess.txt | 4 +- ...-api-clusters-listCloudProviderRegions.txt | 4 +- .../atlas-api-clusters-listClusters.txt | 4 +- ...pi-clusters-listClustersForAllProjects.txt | 4 +- .../atlas-api-clusters-loadSampleDataset.txt | 4 +- ...lusters-pinFeatureCompatibilityVersion.txt | 4 +- ...i-clusters-revokeMongoDbEmployeeAccess.txt | 4 +- .../atlas-api-clusters-testFailover.txt | 4 +- ...sters-unpinFeatureCompatibilityVersion.txt | 4 +- .../atlas-api-clusters-updateCluster.txt | 4 +- ...ers-updateClusterAdvancedConfiguration.txt | 4 +- ...tlas-api-clusters-upgradeSharedCluster.txt | 4 +- docs/command/atlas-api-clusters.txt | 99 ++----- ...atsLatencyNamespaceClusterMeasurements.txt | 4 +- ...lStatsLatencyNamespaceHostMeasurements.txt | 4 +- ...cs-getCollStatsLatencyNamespaceMetrics.txt | 4 +- ...etCollStatsLatencyNamespacesForCluster.txt | 4 +- ...s-getCollStatsLatencyNamespacesForHost.txt | 4 +- ...ectionLevelMetrics-getPinnedNamespaces.txt | 4 +- ...lectionLevelMetrics-pinNamespacesPatch.txt | 4 +- ...ollectionLevelMetrics-pinNamespacesPut.txt | 4 +- ...collectionLevelMetrics-unpinNamespaces.txt | 4 +- .../atlas-api-collectionLevelMetrics.txt | 49 +--- ...DatabaseRoles-createCustomDatabaseRole.txt | 4 +- ...DatabaseRoles-deleteCustomDatabaseRole.txt | 4 +- ...tomDatabaseRoles-getCustomDatabaseRole.txt | 4 +- ...mDatabaseRoles-listCustomDatabaseRoles.txt | 4 +- ...DatabaseRoles-updateCustomDatabaseRole.txt | 4 +- .../command/atlas-api-customDatabaseRoles.txt | 29 +- ...on-createDataFederationPrivateEndpoint.txt | 4 +- ...dataFederation-createFederatedDatabase.txt | 4 +- ...tion-createOneDataFederationQueryLimit.txt | 4 +- ...on-deleteDataFederationPrivateEndpoint.txt | 4 +- ...dataFederation-deleteFederatedDatabase.txt | 4 +- ...eteOneDataFederationInstanceQueryLimit.txt | 4 +- ...ion-downloadFederatedDatabaseQueryLogs.txt | 4 +- ...ation-getDataFederationPrivateEndpoint.txt | 4 +- ...pi-dataFederation-getFederatedDatabase.txt | 4 +- ...ion-listDataFederationPrivateEndpoints.txt | 4 +- ...-dataFederation-listFederatedDatabases.txt | 4 +- ...tion-returnFederatedDatabaseQueryLimit.txt | 4 +- ...ion-returnFederatedDatabaseQueryLimits.txt | 4 +- ...dataFederation-updateFederatedDatabase.txt | 4 +- docs/command/atlas-api-dataFederation.txt | 74 ++--- ...s-api-dataLakePipelines-createPipeline.txt | 4 +- ...s-api-dataLakePipelines-deletePipeline.txt | 4 +- ...LakePipelines-deletePipelineRunDataset.txt | 4 +- ...tlas-api-dataLakePipelines-getPipeline.txt | 4 +- ...s-api-dataLakePipelines-getPipelineRun.txt | 4 +- ...api-dataLakePipelines-listPipelineRuns.txt | 4 +- ...ataLakePipelines-listPipelineSchedules.txt | 4 +- ...ataLakePipelines-listPipelineSnapshots.txt | 4 +- ...as-api-dataLakePipelines-listPipelines.txt | 4 +- ...as-api-dataLakePipelines-pausePipeline.txt | 4 +- ...s-api-dataLakePipelines-resumePipeline.txt | 4 +- ...LakePipelines-triggerSnapshotIngestion.txt | 4 +- ...s-api-dataLakePipelines-updatePipeline.txt | 4 +- docs/command/atlas-api-dataLakePipelines.txt | 71 ++--- ...s-api-databaseUsers-createDatabaseUser.txt | 4 +- ...s-api-databaseUsers-deleteDatabaseUser.txt | 4 +- ...tlas-api-databaseUsers-getDatabaseUser.txt | 4 +- ...as-api-databaseUsers-listDatabaseUsers.txt | 4 +- ...s-api-databaseUsers-updateDatabaseUser.txt | 4 +- docs/command/atlas-api-databaseUsers.txt | 31 +-- ...-createEncryptionAtRestPrivateEndpoint.txt | 4 +- ...tomerKeyManagement-getEncryptionAtRest.txt | 4 +- ...ent-getEncryptionAtRestPrivateEndpoint.txt | 4 +- ...AtRestPrivateEndpointsForCloudProvider.txt | 4 +- ...ncryptionAtRestPrivateEndpointDeletion.txt | 4 +- ...erKeyManagement-updateEncryptionAtRest.txt | 4 +- ...yptionAtRestUsingCustomerKeyManagement.txt | 34 +-- .../atlas-api-events-getOrganizationEvent.txt | 4 +- .../atlas-api-events-getProjectEvent.txt | 4 +- .../atlas-api-events-listEventTypes.txt | 4 +- ...tlas-api-events-listOrganizationEvents.txt | 4 +- .../atlas-api-events-listProjectEvents.txt | 4 +- docs/command/atlas-api-events.txt | 29 +- ...dAuthentication-createIdentityProvider.txt | 4 +- ...eratedAuthentication-createRoleMapping.txt | 4 +- ...atedAuthentication-deleteFederationApp.txt | 4 +- ...dAuthentication-deleteIdentityProvider.txt | 4 +- ...eratedAuthentication-deleteRoleMapping.txt | 4 +- ...edAuthentication-getConnectedOrgConfig.txt | 4 +- ...edAuthentication-getFederationSettings.txt | 4 +- ...atedAuthentication-getIdentityProvider.txt | 4 +- ...entication-getIdentityProviderMetadata.txt | 4 +- ...federatedAuthentication-getRoleMapping.txt | 4 +- ...Authentication-listConnectedOrgConfigs.txt | 4 +- ...edAuthentication-listIdentityProviders.txt | 4 +- ...deratedAuthentication-listRoleMappings.txt | 4 +- ...uthentication-removeConnectedOrgConfig.txt | 4 +- ...ication-revokeJwksFromIdentityProvider.txt | 4 +- ...uthentication-updateConnectedOrgConfig.txt | 4 +- ...dAuthentication-updateIdentityProvider.txt | 4 +- ...eratedAuthentication-updateRoleMapping.txt | 4 +- .../atlas-api-federatedAuthentication.txt | 96 ++----- ...las-api-flexClusters-createFlexCluster.txt | 4 +- ...las-api-flexClusters-deleteFlexCluster.txt | 4 +- .../atlas-api-flexClusters-getFlexCluster.txt | 4 +- ...tlas-api-flexClusters-listFlexClusters.txt | 4 +- ...las-api-flexClusters-updateFlexCluster.txt | 4 +- ...as-api-flexClusters-upgradeFlexCluster.txt | 4 +- docs/command/atlas-api-flexClusters.txt | 36 +-- ...RestoreJobs-createFlexBackupRestoreJob.txt | 4 +- ...lexRestoreJobs-getFlexBackupRestoreJob.txt | 4 +- ...xRestoreJobs-listFlexBackupRestoreJobs.txt | 4 +- docs/command/atlas-api-flexRestoreJobs.txt | 21 +- ...s-api-flexSnapshots-downloadFlexBackup.txt | 4 +- .../atlas-api-flexSnapshots-getFlexBackup.txt | 4 +- ...tlas-api-flexSnapshots-listFlexBackups.txt | 4 +- docs/command/atlas-api-flexSnapshots.txt | 21 +- ...globalClusters-createCustomZoneMapping.txt | 4 +- ...-globalClusters-createManagedNamespace.txt | 4 +- ...alClusters-deleteAllCustomZoneMappings.txt | 4 +- ...-globalClusters-deleteManagedNamespace.txt | 4 +- ...api-globalClusters-getManagedNamespace.txt | 4 +- docs/command/atlas-api-globalClusters.txt | 29 +- ...nvoices-createCostExplorerQueryProcess.txt | 4 +- .../atlas-api-invoices-downloadInvoiceCsv.txt | 4 +- ...i-invoices-getCostExplorerQueryProcess.txt | 4 +- .../command/atlas-api-invoices-getInvoice.txt | 4 +- .../atlas-api-invoices-listInvoices.txt | 4 +- ...atlas-api-invoices-listPendingInvoices.txt | 4 +- ...voices-queryLineItemsFromSingleInvoice.txt | 4 +- docs/command/atlas-api-invoices.txt | 41 +-- ...pConfiguration-deleteLdapConfiguration.txt | 4 +- ...ldapConfiguration-getLdapConfiguration.txt | 4 +- ...nfiguration-getLdapConfigurationStatus.txt | 4 +- ...dapConfiguration-saveLdapConfiguration.txt | 4 +- ...pConfiguration-verifyLdapConfiguration.txt | 4 +- docs/command/atlas-api-ldapConfiguration.txt | 29 +- ...acyBackup-createLegacyBackupRestoreJob.txt | 4 +- ...-api-legacyBackup-deleteLegacySnapshot.txt | 4 +- ...legacyBackup-getLegacyBackupCheckpoint.txt | 4 +- ...legacyBackup-getLegacyBackupRestoreJob.txt | 4 +- ...las-api-legacyBackup-getLegacySnapshot.txt | 4 +- ...legacyBackup-getLegacySnapshotSchedule.txt | 4 +- ...gacyBackup-listLegacyBackupCheckpoints.txt | 4 +- ...gacyBackup-listLegacyBackupRestoreJobs.txt | 4 +- ...s-api-legacyBackup-listLegacySnapshots.txt | 4 +- ...cyBackup-updateLegacySnapshotRetention.txt | 4 +- ...acyBackup-updateLegacySnapshotSchedule.txt | 4 +- docs/command/atlas-api-legacyBackup.txt | 61 ++--- ...ntenanceWindows-deferMaintenanceWindow.txt | 4 +- ...aintenanceWindows-getMaintenanceWindow.txt | 4 +- ...ntenanceWindows-resetMaintenanceWindow.txt | 4 +- ...anceWindows-toggleMaintenanceAutoDefer.txt | 4 +- ...tenanceWindows-updateMaintenanceWindow.txt | 4 +- docs/command/atlas-api-maintenanceWindows.txt | 29 +- ...-mongoDbCloudUsers-addOrganizationRole.txt | 4 +- ...s-api-mongoDbCloudUsers-addProjectRole.txt | 4 +- ...s-api-mongoDbCloudUsers-addProjectUser.txt | 4 +- ...as-api-mongoDbCloudUsers-addUserToTeam.txt | 4 +- ...ngoDbCloudUsers-createOrganizationUser.txt | 4 +- ...atlas-api-mongoDbCloudUsers-createUser.txt | 4 +- ...-mongoDbCloudUsers-getOrganizationUser.txt | 4 +- ...s-api-mongoDbCloudUsers-getProjectUser.txt | 4 +- .../atlas-api-mongoDbCloudUsers-getUser.txt | 4 +- ...pi-mongoDbCloudUsers-getUserByUsername.txt | 4 +- ...ongoDbCloudUsers-listOrganizationUsers.txt | 4 +- ...api-mongoDbCloudUsers-listProjectUsers.txt | 4 +- ...as-api-mongoDbCloudUsers-listTeamUsers.txt | 4 +- ...ngoDbCloudUsers-removeOrganizationRole.txt | 4 +- ...ngoDbCloudUsers-removeOrganizationUser.txt | 4 +- ...pi-mongoDbCloudUsers-removeProjectRole.txt | 4 +- ...pi-mongoDbCloudUsers-removeProjectUser.txt | 4 +- ...i-mongoDbCloudUsers-removeUserFromTeam.txt | 4 +- ...ngoDbCloudUsers-updateOrganizationUser.txt | 4 +- docs/command/atlas-api-mongoDbCloudUsers.txt | 101 ++----- ...-api-monitoringAndLogs-getAtlasProcess.txt | 4 +- ...tlas-api-monitoringAndLogs-getDatabase.txt | 4 +- ...itoringAndLogs-getDatabaseMeasurements.txt | 4 +- ...-monitoringAndLogs-getDiskMeasurements.txt | 4 +- ...tlas-api-monitoringAndLogs-getHostLogs.txt | 4 +- ...-monitoringAndLogs-getHostMeasurements.txt | 4 +- ...-api-monitoringAndLogs-getIndexMetrics.txt | 4 +- ...-api-monitoringAndLogs-getMeasurements.txt | 4 +- ...i-monitoringAndLogs-listAtlasProcesses.txt | 4 +- ...as-api-monitoringAndLogs-listDatabases.txt | 4 +- ...monitoringAndLogs-listDiskMeasurements.txt | 4 +- ...i-monitoringAndLogs-listDiskPartitions.txt | 4 +- ...api-monitoringAndLogs-listIndexMetrics.txt | 4 +- ...-api-monitoringAndLogs-listMetricTypes.txt | 4 +- docs/command/atlas-api-monitoringAndLogs.txt | 76 ++---- ...networkPeering-createPeeringConnection.txt | 4 +- ...-networkPeering-createPeeringContainer.txt | 4 +- ...networkPeering-deletePeeringConnection.txt | 4 +- ...-networkPeering-deletePeeringContainer.txt | 4 +- ...tlas-api-networkPeering-disablePeering.txt | 4 +- ...pi-networkPeering-getPeeringConnection.txt | 4 +- ...api-networkPeering-getPeeringContainer.txt | 4 +- ...-networkPeering-listPeeringConnections.txt | 4 +- ...ng-listPeeringContainerByCloudProvider.txt | 4 +- ...i-networkPeering-listPeeringContainers.txt | 4 +- ...networkPeering-updatePeeringConnection.txt | 4 +- ...-networkPeering-updatePeeringContainer.txt | 4 +- ...ConnectViaPeeringOnlyModeForOneProject.txt | 4 +- docs/command/atlas-api-networkPeering.txt | 69 ++--- ...-api-onlineArchive-createOnlineArchive.txt | 4 +- ...-api-onlineArchive-deleteOnlineArchive.txt | 4 +- ...Archive-downloadOnlineArchiveQueryLogs.txt | 4 +- ...las-api-onlineArchive-getOnlineArchive.txt | 4 +- ...s-api-onlineArchive-listOnlineArchives.txt | 4 +- ...-api-onlineArchive-updateOnlineArchive.txt | 4 +- docs/command/atlas-api-onlineArchive.txt | 36 +-- ...s-api-organizations-createOrganization.txt | 4 +- ...nizations-createOrganizationInvitation.txt | 4 +- ...s-api-organizations-deleteOrganization.txt | 4 +- ...nizations-deleteOrganizationInvitation.txt | 4 +- ...tlas-api-organizations-getOrganization.txt | 4 +- ...rganizations-getOrganizationInvitation.txt | 4 +- ...-organizations-getOrganizationSettings.txt | 4 +- ...anizations-listOrganizationInvitations.txt | 4 +- ...organizations-listOrganizationProjects.txt | 4 +- ...as-api-organizations-listOrganizations.txt | 4 +- ...s-api-organizations-updateOrganization.txt | 4 +- ...nizations-updateOrganizationInvitation.txt | 4 +- ...tions-updateOrganizationInvitationById.txt | 4 +- ...-organizations-updateOrganizationRoles.txt | 4 +- ...ganizations-updateOrganizationSettings.txt | 4 +- docs/command/atlas-api-organizations.txt | 81 ++---- ...visor-disableSlowOperationThresholding.txt | 4 +- ...dvisor-enableSlowOperationThresholding.txt | 4 +- ...pi-performanceAdvisor-getManagedSlowMs.txt | 4 +- ...manceAdvisor-getServerlessAutoIndexing.txt | 4 +- ...nceAdvisor-listClusterSuggestedIndexes.txt | 4 +- ...api-performanceAdvisor-listDropIndexes.txt | 4 +- ...pi-performanceAdvisor-listSchemaAdvice.txt | 4 +- ...api-performanceAdvisor-listSlowQueries.txt | 4 +- ...ormanceAdvisor-listSlowQueryNamespaces.txt | 4 +- ...erformanceAdvisor-listSuggestedIndexes.txt | 4 +- ...manceAdvisor-setServerlessAutoIndexing.txt | 4 +- docs/command/atlas-api-performanceAdvisor.txt | 59 +--- ...EndpointServices-createPrivateEndpoint.txt | 4 +- ...tServices-createPrivateEndpointService.txt | 4 +- ...EndpointServices-deletePrivateEndpoint.txt | 4 +- ...tServices-deletePrivateEndpointService.txt | 4 +- ...ateEndpointServices-getPrivateEndpoint.txt | 4 +- ...ointServices-getPrivateEndpointService.txt | 4 +- ...-getRegionalizedPrivateEndpointSetting.txt | 4 +- ...ntServices-listPrivateEndpointServices.txt | 4 +- ...ggleRegionalizedPrivateEndpointSetting.txt | 4 +- .../atlas-api-privateEndpointServices.txt | 51 +--- ...i-programmaticApiKeys-addProjectApiKey.txt | 4 +- ...s-api-programmaticApiKeys-createApiKey.txt | 4 +- ...rammaticApiKeys-createApiKeyAccessList.txt | 4 +- ...rogrammaticApiKeys-createProjectApiKey.txt | 4 +- ...s-api-programmaticApiKeys-deleteApiKey.txt | 4 +- ...ticApiKeys-deleteApiKeyAccessListEntry.txt | 4 +- ...tlas-api-programmaticApiKeys-getApiKey.txt | 4 +- ...rogrammaticApiKeys-getApiKeyAccessList.txt | 4 +- ...icApiKeys-listApiKeyAccessListsEntries.txt | 4 +- ...as-api-programmaticApiKeys-listApiKeys.txt | 4 +- ...programmaticApiKeys-listProjectApiKeys.txt | 4 +- ...rogrammaticApiKeys-removeProjectApiKey.txt | 4 +- ...s-api-programmaticApiKeys-updateApiKey.txt | 4 +- ...-programmaticApiKeys-updateApiKeyRoles.txt | 4 +- .../command/atlas-api-programmaticApiKeys.txt | 74 ++--- ...IpAccessList-createProjectIpAccessList.txt | 4 +- ...IpAccessList-deleteProjectIpAccessList.txt | 4 +- ...ccessList-getProjectIpAccessListStatus.txt | 4 +- ...i-projectIpAccessList-getProjectIpList.txt | 4 +- ...tIpAccessList-listProjectIpAccessLists.txt | 4 +- .../command/atlas-api-projectIpAccessList.txt | 29 +- .../atlas-api-projects-addUserToProject.txt | 4 +- .../atlas-api-projects-createProject.txt | 4 +- ...s-api-projects-createProjectInvitation.txt | 4 +- .../atlas-api-projects-deleteProject.txt | 4 +- ...s-api-projects-deleteProjectInvitation.txt | 4 +- .../atlas-api-projects-deleteProjectLimit.txt | 4 +- .../command/atlas-api-projects-getProject.txt | 4 +- .../atlas-api-projects-getProjectByName.txt | 4 +- ...tlas-api-projects-getProjectInvitation.txt | 4 +- .../atlas-api-projects-getProjectLimit.txt | 4 +- ...las-api-projects-getProjectLtsVersions.txt | 4 +- .../atlas-api-projects-getProjectSettings.txt | 4 +- ...as-api-projects-listProjectInvitations.txt | 4 +- .../atlas-api-projects-listProjectLimits.txt | 4 +- .../atlas-api-projects-listProjects.txt | 4 +- ...pi-projects-migrateProjectToAnotherOrg.txt | 4 +- ...tlas-api-projects-returnAllIpAddresses.txt | 4 +- .../atlas-api-projects-setProjectLimit.txt | 4 +- .../atlas-api-projects-updateProject.txt | 4 +- ...s-api-projects-updateProjectInvitation.txt | 4 +- ...i-projects-updateProjectInvitationById.txt | 4 +- .../atlas-api-projects-updateProjectRoles.txt | 4 +- ...las-api-projects-updateProjectSettings.txt | 4 +- docs/command/atlas-api-projects.txt | 121 ++------- ...Export-createPushBasedLogConfiguration.txt | 4 +- ...Export-deletePushBasedLogConfiguration.txt | 4 +- ...LogExport-getPushBasedLogConfiguration.txt | 4 +- ...Export-updatePushBasedLogConfiguration.txt | 4 +- docs/command/atlas-api-pushBasedLogExport.txt | 24 +- ...urcePolicies-createAtlasResourcePolicy.txt | 4 +- ...urcePolicies-deleteAtlasResourcePolicy.txt | 4 +- ...ourcePolicies-getAtlasResourcePolicies.txt | 4 +- ...esourcePolicies-getAtlasResourcePolicy.txt | 4 +- ...ourcePolicies-getResourcesNonCompliant.txt | 4 +- ...urcePolicies-updateAtlasResourcePolicy.txt | 4 +- ...cePolicies-validateAtlasResourcePolicy.txt | 4 +- docs/command/atlas-api-resourcePolicies.txt | 41 +-- ...as-api-rollingIndex-createRollingIndex.txt | 4 +- docs/command/atlas-api-rollingIndex.txt | 9 +- .../atlas-api-root-getSystemStatus.txt | 4 +- ...-root-returnAllControlPlaneIpAddresses.txt | 4 +- docs/command/atlas-api-root.txt | 14 +- ...lessInstances-createServerlessInstance.txt | 4 +- ...lessInstances-deleteServerlessInstance.txt | 4 +- ...verlessInstances-getServerlessInstance.txt | 4 +- ...rlessInstances-listServerlessInstances.txt | 4 +- ...lessInstances-updateServerlessInstance.txt | 4 +- .../command/atlas-api-serverlessInstances.txt | 31 +-- ...points-createServerlessPrivateEndpoint.txt | 4 +- ...points-deleteServerlessPrivateEndpoint.txt | 4 +- ...Endpoints-getServerlessPrivateEndpoint.txt | 4 +- ...dpoints-listServerlessPrivateEndpoints.txt | 4 +- ...points-updateServerlessPrivateEndpoint.txt | 4 +- .../atlas-api-serverlessPrivateEndpoints.txt | 29 +- ...rviceAccounts-addProjectServiceAccount.txt | 4 +- ...ceAccounts-createProjectServiceAccount.txt | 4 +- ...-createProjectServiceAccountAccessList.txt | 4 +- ...unts-createProjectServiceAccountSecret.txt | 4 +- ...i-serviceAccounts-createServiceAccount.txt | 4 +- ...ccounts-createServiceAccountAccessList.txt | 4 +- ...iceAccounts-createServiceAccountSecret.txt | 4 +- ...ceAccounts-deleteProjectServiceAccount.txt | 4 +- ...teProjectServiceAccountAccessListEntry.txt | 4 +- ...unts-deleteProjectServiceAccountSecret.txt | 4 +- ...i-serviceAccounts-deleteServiceAccount.txt | 4 +- ...ts-deleteServiceAccountAccessListEntry.txt | 4 +- ...iceAccounts-deleteServiceAccountSecret.txt | 4 +- ...rviceAccounts-getProjectServiceAccount.txt | 4 +- ...-api-serviceAccounts-getServiceAccount.txt | 4 +- ...ts-listProjectServiceAccountAccessList.txt | 4 +- ...iceAccounts-listProjectServiceAccounts.txt | 4 +- ...eAccounts-listServiceAccountAccessList.txt | 4 +- ...iceAccounts-listServiceAccountProjects.txt | 4 +- ...pi-serviceAccounts-listServiceAccounts.txt | 4 +- ...ceAccounts-updateProjectServiceAccount.txt | 4 +- ...i-serviceAccounts-updateServiceAccount.txt | 4 +- docs/command/atlas-api-serviceAccounts.txt | 114 ++------ ...bs-createSharedClusterBackupRestoreJob.txt | 4 +- ...eJobs-getSharedClusterBackupRestoreJob.txt | 4 +- ...obs-listSharedClusterBackupRestoreJobs.txt | 4 +- .../atlas-api-sharedTierRestoreJobs.txt | 21 +- ...rSnapshots-downloadSharedClusterBackup.txt | 4 +- ...edTierSnapshots-getSharedClusterBackup.txt | 4 +- ...TierSnapshots-listSharedClusterBackups.txt | 4 +- .../command/atlas-api-sharedTierSnapshots.txt | 21 +- ...api-streams-acceptVpcPeeringConnection.txt | 4 +- ...pi-streams-createPrivateLinkConnection.txt | 4 +- ...las-api-streams-createStreamConnection.txt | 4 +- ...atlas-api-streams-createStreamInstance.txt | 4 +- ...ateStreamInstanceWithSampleConnections.txt | 4 +- ...tlas-api-streams-createStreamProcessor.txt | 4 +- ...pi-streams-deletePrivateLinkConnection.txt | 4 +- ...las-api-streams-deleteStreamConnection.txt | 4 +- ...atlas-api-streams-deleteStreamInstance.txt | 4 +- ...tlas-api-streams-deleteStreamProcessor.txt | 4 +- ...api-streams-deleteVpcPeeringConnection.txt | 4 +- ...-streams-downloadStreamTenantAuditLogs.txt | 4 +- .../atlas-api-streams-getAccountDetails.txt | 4 +- ...streams-getActiveVpcPeeringConnections.txt | 4 +- ...s-api-streams-getPrivateLinkConnection.txt | 4 +- .../atlas-api-streams-getStreamConnection.txt | 4 +- .../atlas-api-streams-getStreamInstance.txt | 4 +- .../atlas-api-streams-getStreamProcessor.txt | 4 +- ...s-api-streams-getVpcPeeringConnections.txt | 4 +- ...api-streams-listPrivateLinkConnections.txt | 4 +- ...tlas-api-streams-listStreamConnections.txt | 4 +- .../atlas-api-streams-listStreamInstances.txt | 4 +- ...atlas-api-streams-listStreamProcessors.txt | 4 +- ...tlas-api-streams-modifyStreamProcessor.txt | 4 +- ...api-streams-rejectVpcPeeringConnection.txt | 4 +- ...atlas-api-streams-startStreamProcessor.txt | 4 +- ...s-api-streams-startStreamProcessorWith.txt | 4 +- .../atlas-api-streams-stopStreamProcessor.txt | 4 +- ...las-api-streams-updateStreamConnection.txt | 4 +- ...atlas-api-streams-updateStreamInstance.txt | 4 +- docs/command/atlas-api-streams.txt | 154 +++-------- .../atlas-api-teams-addAllTeamsToProject.txt | 4 +- docs/command/atlas-api-teams-addTeamUser.txt | 4 +- docs/command/atlas-api-teams-createTeam.txt | 4 +- docs/command/atlas-api-teams-deleteTeam.txt | 4 +- docs/command/atlas-api-teams-getTeamById.txt | 4 +- .../command/atlas-api-teams-getTeamByName.txt | 4 +- .../atlas-api-teams-listOrganizationTeams.txt | 4 +- .../atlas-api-teams-listProjectTeams.txt | 4 +- .../atlas-api-teams-removeProjectTeam.txt | 4 +- .../atlas-api-teams-removeTeamUser.txt | 4 +- docs/command/atlas-api-teams-renameTeam.txt | 4 +- .../atlas-api-teams-updateTeamRoles.txt | 4 +- docs/command/atlas-api-teams.txt | 66 ++--- ...tegrations-createThirdPartyIntegration.txt | 4 +- ...tegrations-deleteThirdPartyIntegration.txt | 4 +- ...yIntegrations-getThirdPartyIntegration.txt | 4 +- ...ntegrations-listThirdPartyIntegrations.txt | 4 +- ...tegrations-updateThirdPartyIntegration.txt | 4 +- .../atlas-api-thirdPartyIntegrations.txt | 29 +- ...tication-createDatabaseUserCertificate.txt | 4 +- ...hentication-disableCustomerManagedX509.txt | 4 +- ...ntication-listDatabaseUserCertificates.txt | 4 +- docs/command/atlas-api-x509Authentication.txt | 19 +- docs/command/atlas-api.txt | 255 ++++-------------- docs/command/atlas-auditing-describe.txt | 5 + docs/command/atlas-auditing-update.txt | 5 + docs/command/atlas-auditing.txt | 7 + docs/command/atlas-auth-login.txt | 7 + docs/command/atlas-auth-logout.txt | 7 + docs/command/atlas-auth-register.txt | 7 + docs/command/atlas-auth-whoami.txt | 7 + docs/command/atlas-auth.txt | 7 + ...ompliancePolicy-copyProtection-disable.txt | 7 + ...compliancePolicy-copyProtection-enable.txt | 7 + ...ackups-compliancePolicy-copyProtection.txt | 7 + ...tlas-backups-compliancePolicy-describe.txt | 7 + .../atlas-backups-compliancePolicy-enable.txt | 7 + ...pliancePolicy-encryptionAtRest-disable.txt | 7 + ...mpliancePolicy-encryptionAtRest-enable.txt | 7 + ...kups-compliancePolicy-encryptionAtRest.txt | 7 + ...iancePolicy-pointInTimeRestores-enable.txt | 7 + ...s-compliancePolicy-pointInTimeRestores.txt | 7 + ...ups-compliancePolicy-policies-describe.txt | 7 + ...pliancePolicy-policies-ondemand-create.txt | 7 + ...iancePolicy-policies-ondemand-describe.txt | 7 + ...pliancePolicy-policies-ondemand-update.txt | 7 + ...ups-compliancePolicy-policies-ondemand.txt | 7 + ...liancePolicy-policies-scheduled-create.txt | 7 + ...ancePolicy-policies-scheduled-describe.txt | 7 + ...ps-compliancePolicy-policies-scheduled.txt | 7 + ...tlas-backups-compliancePolicy-policies.txt | 7 + .../atlas-backups-compliancePolicy-setup.txt | 7 + .../atlas-backups-compliancePolicy.txt | 7 + .../atlas-backups-exports-buckets-create.txt | 5 + .../atlas-backups-exports-buckets-delete.txt | 5 + ...atlas-backups-exports-buckets-describe.txt | 5 + .../atlas-backups-exports-buckets-list.txt | 5 + .../command/atlas-backups-exports-buckets.txt | 7 + .../atlas-backups-exports-jobs-create.txt | 5 + .../atlas-backups-exports-jobs-describe.txt | 5 + .../atlas-backups-exports-jobs-list.txt | 5 + .../atlas-backups-exports-jobs-watch.txt | 5 + docs/command/atlas-backups-exports-jobs.txt | 7 + docs/command/atlas-backups-exports.txt | 7 + .../atlas-backups-restores-describe.txt | 5 + docs/command/atlas-backups-restores-list.txt | 5 + docs/command/atlas-backups-restores-start.txt | 5 + docs/command/atlas-backups-restores-watch.txt | 5 + docs/command/atlas-backups-restores.txt | 7 + .../command/atlas-backups-schedule-delete.txt | 5 + .../atlas-backups-schedule-describe.txt | 5 + .../command/atlas-backups-schedule-update.txt | 5 + docs/command/atlas-backups-schedule.txt | 7 + .../atlas-backups-snapshots-create.txt | 5 + .../atlas-backups-snapshots-delete.txt | 5 + .../atlas-backups-snapshots-describe.txt | 5 + .../atlas-backups-snapshots-download.txt | 5 + docs/command/atlas-backups-snapshots-list.txt | 5 + .../command/atlas-backups-snapshots-watch.txt | 5 + docs/command/atlas-backups-snapshots.txt | 7 + docs/command/atlas-backups.txt | 7 + ...oudProviders-accessRoles-aws-authorize.txt | 7 + ...-cloudProviders-accessRoles-aws-create.txt | 5 + ...dProviders-accessRoles-aws-deauthorize.txt | 5 + .../atlas-cloudProviders-accessRoles-aws.txt | 7 + .../atlas-cloudProviders-accessRoles-list.txt | 5 + .../atlas-cloudProviders-accessRoles.txt | 7 + docs/command/atlas-cloudProviders.txt | 7 + ...las-clusters-advancedSettings-describe.txt | 5 + ...atlas-clusters-advancedSettings-update.txt | 5 + .../atlas-clusters-advancedSettings.txt | 7 + .../atlas-clusters-availableRegions-list.txt | 7 + .../atlas-clusters-availableRegions.txt | 7 + ...as-clusters-connectionStrings-describe.txt | 5 + .../atlas-clusters-connectionStrings.txt | 7 + docs/command/atlas-clusters-create.txt | 5 + docs/command/atlas-clusters-delete.txt | 5 + docs/command/atlas-clusters-describe.txt | 5 + docs/command/atlas-clusters-failover.txt | 5 + .../command/atlas-clusters-indexes-create.txt | 5 + docs/command/atlas-clusters-indexes.txt | 7 + docs/command/atlas-clusters-list.txt | 5 + .../atlas-clusters-onlineArchives-create.txt | 5 + .../atlas-clusters-onlineArchives-delete.txt | 5 + ...atlas-clusters-onlineArchives-describe.txt | 5 + .../atlas-clusters-onlineArchives-list.txt | 5 + .../atlas-clusters-onlineArchives-pause.txt | 5 + .../atlas-clusters-onlineArchives-start.txt | 5 + .../atlas-clusters-onlineArchives-update.txt | 5 + .../atlas-clusters-onlineArchives-watch.txt | 5 + .../command/atlas-clusters-onlineArchives.txt | 7 + docs/command/atlas-clusters-pause.txt | 5 + .../atlas-clusters-sampleData-describe.txt | 5 + .../atlas-clusters-sampleData-load.txt | 5 + .../atlas-clusters-sampleData-watch.txt | 5 + docs/command/atlas-clusters-sampleData.txt | 5 + .../atlas-clusters-search-indexes-create.txt | 5 + .../atlas-clusters-search-indexes-delete.txt | 5 + ...atlas-clusters-search-indexes-describe.txt | 5 + .../atlas-clusters-search-indexes-list.txt | 5 + .../atlas-clusters-search-indexes-update.txt | 5 + .../command/atlas-clusters-search-indexes.txt | 7 + .../atlas-clusters-search-nodes-create.txt | 5 + .../atlas-clusters-search-nodes-delete.txt | 5 + .../atlas-clusters-search-nodes-list.txt | 5 + .../atlas-clusters-search-nodes-update.txt | 5 + docs/command/atlas-clusters-search-nodes.txt | 7 + docs/command/atlas-clusters-search.txt | 7 + docs/command/atlas-clusters-start.txt | 5 + docs/command/atlas-clusters-update.txt | 5 + docs/command/atlas-clusters-upgrade.txt | 5 + docs/command/atlas-clusters-watch.txt | 5 + docs/command/atlas-clusters.txt | 5 + docs/command/atlas-completion-fish.txt | 5 + docs/command/atlas-completion-powershell.txt | 5 + docs/command/atlas-completion-zsh.txt | 5 + docs/command/atlas-completion.txt | 5 + docs/command/atlas-config-delete.txt | 7 + docs/command/atlas-config-describe.txt | 7 + docs/command/atlas-config-edit.txt | 5 + docs/command/atlas-config-init.txt | 7 + docs/command/atlas-config-list.txt | 5 + docs/command/atlas-config-rename.txt | 7 + docs/command/atlas-config-set.txt | 7 + docs/command/atlas-config.txt | 5 + docs/command/atlas-customDbRoles-create.txt | 5 + docs/command/atlas-customDbRoles-delete.txt | 5 + docs/command/atlas-customDbRoles-describe.txt | 5 + docs/command/atlas-customDbRoles-list.txt | 5 + docs/command/atlas-customDbRoles-update.txt | 5 + docs/command/atlas-customDbRoles.txt | 7 + docs/command/atlas-customDns-aws-describe.txt | 5 + docs/command/atlas-customDns-aws-disable.txt | 5 + docs/command/atlas-customDns-aws-enable.txt | 5 + docs/command/atlas-customDns-aws.txt | 7 + docs/command/atlas-customDns.txt | 7 + docs/command/atlas-dataFederation-create.txt | 5 + docs/command/atlas-dataFederation-delete.txt | 5 + .../command/atlas-dataFederation-describe.txt | 5 + docs/command/atlas-dataFederation-list.txt | 5 + docs/command/atlas-dataFederation-logs.txt | 5 + ...dataFederation-privateEndpoints-create.txt | 5 + ...dataFederation-privateEndpoints-delete.txt | 5 + ...taFederation-privateEndpoints-describe.txt | 5 + ...s-dataFederation-privateEndpoints-list.txt | 5 + .../atlas-dataFederation-privateEndpoints.txt | 7 + ...tlas-dataFederation-queryLimits-create.txt | 5 + ...tlas-dataFederation-queryLimits-delete.txt | 5 + ...as-dataFederation-queryLimits-describe.txt | 5 + .../atlas-dataFederation-queryLimits-list.txt | 5 + .../atlas-dataFederation-queryLimits.txt | 7 + docs/command/atlas-dataFederation-update.txt | 5 + docs/command/atlas-dataFederation.txt | 7 + docs/command/atlas-dbusers-certs-create.txt | 5 + docs/command/atlas-dbusers-certs-list.txt | 5 + docs/command/atlas-dbusers-certs.txt | 7 + docs/command/atlas-dbusers-create.txt | 5 + docs/command/atlas-dbusers-delete.txt | 5 + docs/command/atlas-dbusers-describe.txt | 5 + docs/command/atlas-dbusers-list.txt | 5 + docs/command/atlas-dbusers-update.txt | 5 + docs/command/atlas-dbusers.txt | 5 + docs/command/atlas-deployments-connect.txt | 7 + docs/command/atlas-deployments-delete.txt | 5 + docs/command/atlas-deployments-list.txt | 7 + docs/command/atlas-deployments-logs.txt | 7 + docs/command/atlas-deployments-pause.txt | 7 + ...tlas-deployments-search-indexes-create.txt | 7 + ...tlas-deployments-search-indexes-delete.txt | 7 + ...as-deployments-search-indexes-describe.txt | 7 + .../atlas-deployments-search-indexes-list.txt | 7 + .../atlas-deployments-search-indexes.txt | 7 + docs/command/atlas-deployments-search.txt | 7 + docs/command/atlas-deployments-setup.txt | 5 + docs/command/atlas-deployments-start.txt | 5 + docs/command/atlas-deployments.txt | 7 + .../atlas-events-organizations-list.txt | 7 + docs/command/atlas-events-organizations.txt | 5 + docs/command/atlas-events-projects-list.txt | 7 + docs/command/atlas-events-projects.txt | 5 + docs/command/atlas-events.txt | 7 + ...onSettings-connectedOrgConfigs-connect.txt | 7 + ...ionSettings-connectedOrgConfigs-delete.txt | 7 + ...nSettings-connectedOrgConfigs-describe.txt | 7 + ...ettings-connectedOrgConfigs-disconnect.txt | 7 + ...ationSettings-connectedOrgConfigs-list.txt | 7 + ...ionSettings-connectedOrgConfigs-update.txt | 7 + ...federationSettings-connectedOrgConfigs.txt | 7 + ...entication-federationSettings-describe.txt | 5 + ...nSettings-identityProvider-create-oidc.txt | 7 + ...rationSettings-identityProvider-create.txt | 7 + ...rationSettings-identityProvider-delete.txt | 5 + ...tionSettings-identityProvider-describe.txt | 5 + ...derationSettings-identityProvider-list.txt | 5 + ...ionSettings-identityProvider-revokeJwk.txt | 5 + ...nSettings-identityProvider-update-oidc.txt | 7 + ...rationSettings-identityProvider-update.txt | 7 + ...on-federationSettings-identityProvider.txt | 7 + ...ratedAuthentication-federationSettings.txt | 7 + .../command/atlas-federatedAuthentication.txt | 7 + .../atlas-integrations-create-DATADOG.txt | 5 + .../atlas-integrations-create-OPS_GENIE.txt | 5 + .../atlas-integrations-create-PAGER_DUTY.txt | 5 + .../atlas-integrations-create-VICTOR_OPS.txt | 5 + .../atlas-integrations-create-WEBHOOK.txt | 5 + docs/command/atlas-integrations-create.txt | 7 + docs/command/atlas-integrations-delete.txt | 5 + docs/command/atlas-integrations-describe.txt | 5 + docs/command/atlas-integrations-list.txt | 5 + docs/command/atlas-integrations.txt | 7 + docs/command/atlas-liveMigrations-create.txt | 5 + docs/command/atlas-liveMigrations-cutover.txt | 5 + .../command/atlas-liveMigrations-describe.txt | 7 + .../atlas-liveMigrations-link-create.txt | 5 + .../atlas-liveMigrations-link-delete.txt | 7 + docs/command/atlas-liveMigrations-link.txt | 7 + ...atlas-liveMigrations-validation-create.txt | 5 + ...las-liveMigrations-validation-describe.txt | 7 + .../atlas-liveMigrations-validation.txt | 7 + docs/command/atlas-liveMigrations.txt | 7 + docs/command/atlas-logs-download.txt | 5 + docs/command/atlas-logs.txt | 7 + .../atlas-maintenanceWindows-clear.txt | 5 + .../atlas-maintenanceWindows-defer.txt | 5 + .../atlas-maintenanceWindows-describe.txt | 5 + .../atlas-maintenanceWindows-update.txt | 5 + docs/command/atlas-maintenanceWindows.txt | 7 + .../atlas-metrics-databases-describe.txt | 5 + docs/command/atlas-metrics-databases-list.txt | 5 + docs/command/atlas-metrics-databases.txt | 7 + docs/command/atlas-metrics-disks-describe.txt | 5 + docs/command/atlas-metrics-disks-list.txt | 5 + docs/command/atlas-metrics-disks.txt | 7 + docs/command/atlas-metrics-processes.txt | 5 + docs/command/atlas-metrics.txt | 7 + .../atlas-networking-containers-delete.txt | 5 + .../atlas-networking-containers-list.txt | 5 + docs/command/atlas-networking-containers.txt | 7 + .../atlas-networking-peering-create-aws.txt | 5 + .../atlas-networking-peering-create-azure.txt | 5 + .../atlas-networking-peering-create-gcp.txt | 5 + .../atlas-networking-peering-create.txt | 7 + .../atlas-networking-peering-delete.txt | 5 + .../command/atlas-networking-peering-list.txt | 5 + .../atlas-networking-peering-watch.txt | 5 + docs/command/atlas-networking-peering.txt | 7 + docs/command/atlas-networking.txt | 7 + ...ganizations-apiKeys-accessLists-create.txt | 5 + ...ganizations-apiKeys-accessLists-delete.txt | 5 + ...organizations-apiKeys-accessLists-list.txt | 5 + ...tlas-organizations-apiKeys-accessLists.txt | 7 + .../atlas-organizations-apiKeys-assign.txt | 5 + .../atlas-organizations-apiKeys-create.txt | 5 + .../atlas-organizations-apiKeys-delete.txt | 5 + .../atlas-organizations-apiKeys-describe.txt | 5 + .../atlas-organizations-apiKeys-list.txt | 5 + docs/command/atlas-organizations-apiKeys.txt | 7 + docs/command/atlas-organizations-create.txt | 5 + docs/command/atlas-organizations-delete.txt | 5 + docs/command/atlas-organizations-describe.txt | 5 + ...atlas-organizations-invitations-delete.txt | 5 + ...las-organizations-invitations-describe.txt | 5 + ...atlas-organizations-invitations-invite.txt | 5 + .../atlas-organizations-invitations-list.txt | 5 + ...atlas-organizations-invitations-update.txt | 5 + .../atlas-organizations-invitations.txt | 5 + docs/command/atlas-organizations-list.txt | 5 + .../atlas-organizations-users-list.txt | 5 + docs/command/atlas-organizations-users.txt | 7 + docs/command/atlas-organizations.txt | 5 + ...las-performanceAdvisor-namespaces-list.txt | 5 + .../atlas-performanceAdvisor-namespaces.txt | 7 + ...Advisor-slowOperationThreshold-disable.txt | 5 + ...eAdvisor-slowOperationThreshold-enable.txt | 5 + ...formanceAdvisor-slowOperationThreshold.txt | 7 + ...-performanceAdvisor-slowQueryLogs-list.txt | 5 + ...atlas-performanceAdvisor-slowQueryLogs.txt | 7 + ...rformanceAdvisor-suggestedIndexes-list.txt | 5 + ...as-performanceAdvisor-suggestedIndexes.txt | 7 + docs/command/atlas-performanceAdvisor.txt | 7 + docs/command/atlas-plugin-install.txt | 5 + docs/command/atlas-plugin-list.txt | 7 + docs/command/atlas-plugin-uninstall.txt | 5 + docs/command/atlas-plugin-update.txt | 5 + docs/command/atlas-plugin.txt | 7 + .../atlas-privateEndpoints-aws-create.txt | 5 + .../atlas-privateEndpoints-aws-delete.txt | 5 + .../atlas-privateEndpoints-aws-describe.txt | 5 + ...privateEndpoints-aws-interfaces-create.txt | 5 + ...privateEndpoints-aws-interfaces-delete.txt | 5 + ...ivateEndpoints-aws-interfaces-describe.txt | 5 + .../atlas-privateEndpoints-aws-interfaces.txt | 7 + .../atlas-privateEndpoints-aws-list.txt | 5 + .../atlas-privateEndpoints-aws-watch.txt | 5 + docs/command/atlas-privateEndpoints-aws.txt | 7 + .../atlas-privateEndpoints-azure-create.txt | 5 + .../atlas-privateEndpoints-azure-delete.txt | 5 + .../atlas-privateEndpoints-azure-describe.txt | 5 + ...ivateEndpoints-azure-interfaces-create.txt | 5 + ...ivateEndpoints-azure-interfaces-delete.txt | 5 + ...ateEndpoints-azure-interfaces-describe.txt | 5 + ...tlas-privateEndpoints-azure-interfaces.txt | 7 + .../atlas-privateEndpoints-azure-list.txt | 5 + .../atlas-privateEndpoints-azure-watch.txt | 5 + docs/command/atlas-privateEndpoints-azure.txt | 7 + .../atlas-privateEndpoints-gcp-create.txt | 5 + .../atlas-privateEndpoints-gcp-delete.txt | 5 + .../atlas-privateEndpoints-gcp-describe.txt | 5 + ...privateEndpoints-gcp-interfaces-create.txt | 5 + ...privateEndpoints-gcp-interfaces-delete.txt | 5 + ...ivateEndpoints-gcp-interfaces-describe.txt | 5 + .../atlas-privateEndpoints-gcp-interfaces.txt | 7 + .../atlas-privateEndpoints-gcp-list.txt | 5 + .../atlas-privateEndpoints-gcp-watch.txt | 5 + docs/command/atlas-privateEndpoints-gcp.txt | 7 + ...rivateEndpoints-regionalModes-describe.txt | 5 + ...privateEndpoints-regionalModes-disable.txt | 5 + ...-privateEndpoints-regionalModes-enable.txt | 5 + .../atlas-privateEndpoints-regionalModes.txt | 7 + docs/command/atlas-privateEndpoints.txt | 7 + docs/command/atlas-processes-describe.txt | 7 + docs/command/atlas-processes-list.txt | 5 + docs/command/atlas-processes.txt | 7 + .../command/atlas-projects-apiKeys-assign.txt | 5 + .../command/atlas-projects-apiKeys-create.txt | 5 + .../command/atlas-projects-apiKeys-delete.txt | 5 + docs/command/atlas-projects-apiKeys-list.txt | 5 + docs/command/atlas-projects-apiKeys.txt | 7 + docs/command/atlas-projects-create.txt | 5 + docs/command/atlas-projects-delete.txt | 5 + docs/command/atlas-projects-describe.txt | 5 + docs/command/atlas-projects-list.txt | 5 + .../atlas-projects-settings-describe.txt | 7 + .../atlas-projects-settings-update.txt | 7 + docs/command/atlas-projects-settings.txt | 5 + docs/command/atlas-projects-teams-add.txt | 5 + docs/command/atlas-projects-teams-delete.txt | 5 + docs/command/atlas-projects-teams-list.txt | 5 + docs/command/atlas-projects-teams-update.txt | 5 + docs/command/atlas-projects-teams.txt | 7 + docs/command/atlas-projects-update.txt | 5 + docs/command/atlas-projects-users-delete.txt | 5 + docs/command/atlas-projects-users-list.txt | 5 + docs/command/atlas-projects-users.txt | 7 + docs/command/atlas-projects.txt | 5 + .../atlas-security-customerCerts-create.txt | 5 + .../atlas-security-customerCerts-describe.txt | 5 + .../atlas-security-customerCerts-disable.txt | 5 + docs/command/atlas-security-customerCerts.txt | 7 + docs/command/atlas-security-ldap-delete.txt | 5 + docs/command/atlas-security-ldap-get.txt | 5 + docs/command/atlas-security-ldap-save.txt | 5 + ...tlas-security-ldap-verify-status-watch.txt | 5 + .../atlas-security-ldap-verify-status.txt | 5 + docs/command/atlas-security-ldap-verify.txt | 5 + docs/command/atlas-security-ldap.txt | 7 + docs/command/atlas-security.txt | 7 + docs/command/atlas-setup.txt | 5 + .../atlas-streams-connections-create.txt | 5 + .../atlas-streams-connections-delete.txt | 5 + .../atlas-streams-connections-describe.txt | 5 + .../atlas-streams-connections-list.txt | 5 + .../atlas-streams-connections-update.txt | 5 + docs/command/atlas-streams-connections.txt | 5 + .../atlas-streams-instances-create.txt | 5 + .../atlas-streams-instances-delete.txt | 5 + .../atlas-streams-instances-describe.txt | 5 + .../atlas-streams-instances-download.txt | 5 + docs/command/atlas-streams-instances-list.txt | 5 + .../atlas-streams-instances-update.txt | 5 + docs/command/atlas-streams-instances.txt | 5 + .../atlas-streams-privateLinks-create.txt | 5 + .../atlas-streams-privateLinks-delete.txt | 5 + .../atlas-streams-privateLinks-describe.txt | 5 + .../atlas-streams-privateLinks-list.txt | 5 + docs/command/atlas-streams-privateLinks.txt | 5 + docs/command/atlas-streams.txt | 5 + docs/command/atlas-teams-create.txt | 5 + docs/command/atlas-teams-delete.txt | 5 + docs/command/atlas-teams-describe.txt | 5 + docs/command/atlas-teams-list.txt | 5 + docs/command/atlas-teams-rename.txt | 5 + docs/command/atlas-teams-users-add.txt | 5 + docs/command/atlas-teams-users-delete.txt | 5 + docs/command/atlas-teams-users-list.txt | 5 + docs/command/atlas-teams-users.txt | 5 + docs/command/atlas-teams.txt | 5 + docs/command/atlas-users-describe.txt | 5 + docs/command/atlas-users-invite.txt | 5 + docs/command/atlas-users.txt | 5 + docs/command/atlas.txt | 5 + tools/cmd/docs/transformations.go | 3 +- 913 files changed, 4380 insertions(+), 2511 deletions(-) diff --git a/docs/command/atlas-accessLists-create.txt b/docs/command/atlas-accessLists-create.txt index f6bd387293..a9bb62b992 100644 --- a/docs/command/atlas-accessLists-create.txt +++ b/docs/command/atlas-accessLists-create.txt @@ -14,6 +14,11 @@ atlas accessLists create Create an IP access list entry for your project. +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. + + + The access list can contain trusted IP addresses, AWS security group IDs, and entries in Classless Inter-Domain Routing (CIDR) notation. You can add only one access list entry at a time. You can create one access list per project. The command doesn't overwrite existing entries in the access list. Instead, it adds the new entries to the list of entries. diff --git a/docs/command/atlas-accessLists-delete.txt b/docs/command/atlas-accessLists-delete.txt index 9422e69964..26a09e1af8 100644 --- a/docs/command/atlas-accessLists-delete.txt +++ b/docs/command/atlas-accessLists-delete.txt @@ -14,6 +14,11 @@ atlas accessLists delete Remove the specified IP access list entry from your project. +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. + + + The command, when run without the force option, prompts you to confirm the operation. To use this command, you must authenticate with a user account or an API key with the Read Write role. diff --git a/docs/command/atlas-accessLists-describe.txt b/docs/command/atlas-accessLists-describe.txt index b759f71cff..2916020639 100644 --- a/docs/command/atlas-accessLists-describe.txt +++ b/docs/command/atlas-accessLists-describe.txt @@ -14,6 +14,11 @@ atlas accessLists describe Return the details for the specified IP access list entry. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/docs/command/atlas-accessLists-list.txt b/docs/command/atlas-accessLists-list.txt index 7fc068133f..e2c003b9a6 100644 --- a/docs/command/atlas-accessLists-list.txt +++ b/docs/command/atlas-accessLists-list.txt @@ -14,6 +14,11 @@ atlas accessLists list Return all IP access list entries for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/docs/command/atlas-accessLists.txt b/docs/command/atlas-accessLists.txt index 0c5ab90ee3..19b36580ea 100644 --- a/docs/command/atlas-accessLists.txt +++ b/docs/command/atlas-accessLists.txt @@ -14,6 +14,13 @@ atlas accessLists Manage the list of IP addresses that can access your Atlas project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-accessLogs-list.txt b/docs/command/atlas-accessLogs-list.txt index c93e3257ba..eeefb6a3c2 100644 --- a/docs/command/atlas-accessLogs-list.txt +++ b/docs/command/atlas-accessLogs-list.txt @@ -14,6 +14,11 @@ atlas accessLogs list Retrieve the access logs of a cluster identified by the cluster's name or hostname. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Monitoring Admin role. Syntax diff --git a/docs/command/atlas-accessLogs.txt b/docs/command/atlas-accessLogs.txt index 6af9d05156..4e0a23cf30 100644 --- a/docs/command/atlas-accessLogs.txt +++ b/docs/command/atlas-accessLogs.txt @@ -14,6 +14,13 @@ atlas accessLogs Return the access logs for a cluster. +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. + + + + + Options ------- diff --git a/docs/command/atlas-alerts-acknowledge.txt b/docs/command/atlas-alerts-acknowledge.txt index 45e26529e5..f66d042066 100644 --- a/docs/command/atlas-alerts-acknowledge.txt +++ b/docs/command/atlas-alerts-acknowledge.txt @@ -14,6 +14,11 @@ atlas alerts acknowledge Acknowledges the specified alert for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-alerts-describe.txt b/docs/command/atlas-alerts-describe.txt index e67a940624..d95dbd7ee8 100644 --- a/docs/command/atlas-alerts-describe.txt +++ b/docs/command/atlas-alerts-describe.txt @@ -14,6 +14,11 @@ atlas alerts describe Return the details for the specified alert for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-alerts-list.txt b/docs/command/atlas-alerts-list.txt index 1152d673ee..774d3faa92 100644 --- a/docs/command/atlas-alerts-list.txt +++ b/docs/command/atlas-alerts-list.txt @@ -14,6 +14,11 @@ atlas alerts list Return all alerts for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-alerts-settings-create.txt b/docs/command/atlas-alerts-settings-create.txt index 87a1e7c5f3..ab19560667 100644 --- a/docs/command/atlas-alerts-settings-create.txt +++ b/docs/command/atlas-alerts-settings-create.txt @@ -14,6 +14,11 @@ atlas alerts settings create Create an alert configuration for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-alerts-settings-delete.txt b/docs/command/atlas-alerts-settings-delete.txt index 8e22299a39..d33d5acb04 100644 --- a/docs/command/atlas-alerts-settings-delete.txt +++ b/docs/command/atlas-alerts-settings-delete.txt @@ -14,6 +14,11 @@ atlas alerts settings delete Remove the specified alert configuration for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-alerts-settings-describe.txt b/docs/command/atlas-alerts-settings-describe.txt index 323cc68fb3..9125c794ab 100644 --- a/docs/command/atlas-alerts-settings-describe.txt +++ b/docs/command/atlas-alerts-settings-describe.txt @@ -14,6 +14,11 @@ atlas alerts settings describe Return the details for the specified alert settings for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-alerts-settings-disable.txt b/docs/command/atlas-alerts-settings-disable.txt index c63bbd5355..360c0e8f32 100644 --- a/docs/command/atlas-alerts-settings-disable.txt +++ b/docs/command/atlas-alerts-settings-disable.txt @@ -14,6 +14,13 @@ atlas alerts settings disable Disables one alert configuration for the specified project. +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/docs/command/atlas-alerts-settings-enable.txt b/docs/command/atlas-alerts-settings-enable.txt index 9e54331291..81ceb0be67 100644 --- a/docs/command/atlas-alerts-settings-enable.txt +++ b/docs/command/atlas-alerts-settings-enable.txt @@ -14,6 +14,13 @@ atlas alerts settings enable Enables one alert configuration for the specified project. +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/docs/command/atlas-alerts-settings-fields-type.txt b/docs/command/atlas-alerts-settings-fields-type.txt index 891a1ed723..09252b546c 100644 --- a/docs/command/atlas-alerts-settings-fields-type.txt +++ b/docs/command/atlas-alerts-settings-fields-type.txt @@ -14,6 +14,11 @@ atlas alerts settings fields type Return all available field types that the matcherFieldName option accepts when you create or update an alert configuration. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-alerts-settings-fields.txt b/docs/command/atlas-alerts-settings-fields.txt index 1f04c66bc9..2500a9b548 100644 --- a/docs/command/atlas-alerts-settings-fields.txt +++ b/docs/command/atlas-alerts-settings-fields.txt @@ -14,6 +14,13 @@ atlas alerts settings fields Manages alert configuration fields for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-alerts-settings-list.txt b/docs/command/atlas-alerts-settings-list.txt index 18033d8ba0..6b996a3957 100644 --- a/docs/command/atlas-alerts-settings-list.txt +++ b/docs/command/atlas-alerts-settings-list.txt @@ -14,6 +14,11 @@ atlas alerts settings list Returns all alert configurations for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-alerts-settings-update.txt b/docs/command/atlas-alerts-settings-update.txt index a5355972e7..6a08acaeda 100644 --- a/docs/command/atlas-alerts-settings-update.txt +++ b/docs/command/atlas-alerts-settings-update.txt @@ -14,6 +14,11 @@ atlas alerts settings update Modify the details of the specified alert configuration for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-alerts-settings.txt b/docs/command/atlas-alerts-settings.txt index 54f985bec4..64b230daf4 100644 --- a/docs/command/atlas-alerts-settings.txt +++ b/docs/command/atlas-alerts-settings.txt @@ -14,6 +14,11 @@ atlas alerts settings Manages alerts configuration for your project. +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. + + + Use this command to list, create, edit, delete, enable and disable alert configurations. Options diff --git a/docs/command/atlas-alerts-unacknowledge.txt b/docs/command/atlas-alerts-unacknowledge.txt index 9d66e0b105..6c7aa958ed 100644 --- a/docs/command/atlas-alerts-unacknowledge.txt +++ b/docs/command/atlas-alerts-unacknowledge.txt @@ -14,6 +14,11 @@ atlas alerts unacknowledge Unacknowledge the specified alert for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-alerts.txt b/docs/command/atlas-alerts.txt index 75f0f7159e..bdd82ef0fd 100644 --- a/docs/command/atlas-alerts.txt +++ b/docs/command/atlas-alerts.txt @@ -14,6 +14,13 @@ atlas alerts Manage alerts for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt index c5ad59079a..8080d2d818 100644 --- a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt +++ b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt @@ -12,10 +12,12 @@ 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.Returns the access logs of one cluster identified by the cluster's name. + 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. -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 f38a25d82a..8a4332b7ec 100644 --- a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt +++ b/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt @@ -12,10 +12,12 @@ 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.Returns the access logs of one cluster identified by the cluster's hostname. + 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. -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 d9e4e8f095..3d76641081 100644 --- a/docs/command/atlas-api-accessTracking.txt +++ b/docs/command/atlas-api-accessTracking.txt @@ -12,10 +12,12 @@ atlas api accessTracking :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns access logs for authentication attempts made to Atlas database deployments.Returns access logs for authentication attempts made to Atlas database deployments. + 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. -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,14 +56,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - 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. - -Returns the access logs of one cluster identified by the cluster's name. -* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - 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. - -Returns the access logs of one cluster identified by the cluster's hostname. +* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - `Public Preview: please provide feedback `_: Returns the access logs of one cluster identified by the cluster's name.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.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 e29707c781..967e801241 100644 --- a/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt @@ -12,10 +12,12 @@ atlas api alertConfigurations createAlertConfiguration :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one alert configuration for the specified project.Creates one alert configuration for the specified project. + 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. -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 938647c3e8..7e5c310988 100644 --- a/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt @@ -12,10 +12,12 @@ atlas api alertConfigurations deleteAlertConfiguration :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one alert configuration from the specified project.Removes one alert configuration from the specified project. + 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. -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 f461cbc39d..d1c0149286 100644 --- a/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt @@ -12,10 +12,12 @@ atlas api alertConfigurations getAlertConfiguration :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the specified alert configuration from the specified project.Returns the specified alert configuration from the specified project. + 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. -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 f231ba6066..1a614a2925 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt @@ -12,10 +12,12 @@ 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.Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. + 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. -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 f2f9aeaf86..0e586a0ae3 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt @@ -12,10 +12,12 @@ atlas api alertConfigurations listAlertConfigurations :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all alert configurations for one project.Returns all alert configurations for one project. + 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. -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 59d54efd5d..a2857454c1 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt @@ -12,10 +12,12 @@ atlas api alertConfigurations listAlertConfigurationsByAlertId :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all alert configurations set for the specified alert.Returns all alert configurations set for the specified alert. + 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. -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 c7d140f5bc..c1df68eb05 100644 --- a/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt @@ -12,10 +12,12 @@ atlas api alertConfigurations toggleAlertConfiguration :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Enables or disables the specified alert configuration in the specified project.Enables or disables the specified alert configuration in the specified project. + 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. -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 211b152380..2013ae4849 100644 --- a/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt @@ -12,10 +12,12 @@ atlas api alertConfigurations updateAlertConfiguration :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates one alert configuration in the specified project.Updates one alert configuration in the specified project. + 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. -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 f2b0e8a54b..4d6317ebe5 100644 --- a/docs/command/atlas-api-alertConfigurations.txt +++ b/docs/command/atlas-api-alertConfigurations.txt @@ -12,10 +12,12 @@ 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.Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. + 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. -Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. + This collection remains under revision and may change. @@ -54,38 +56,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - 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. - -Creates one alert configuration for the specified project. -* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - 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. - -Removes one alert configuration from the specified project. -* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - 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. - -Returns the specified alert configuration from the specified project. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - 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. - -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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - 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. - -Returns all alert configurations set for the specified alert. -* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - 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. - -Enables or disables the specified alert configuration in the specified project. -* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - 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. - -Updates one alert configuration in the specified project. +* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - `Public Preview: please provide feedback `_: Creates one alert configuration for the specified project.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.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.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.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.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.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.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.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 8945c29752..c1a328a4b2 100644 --- a/docs/command/atlas-api-alerts-acknowledgeAlert.txt +++ b/docs/command/atlas-api-alerts-acknowledgeAlert.txt @@ -12,10 +12,12 @@ atlas api alerts acknowledgeAlert :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Confirms receipt of one existing alert.Confirms receipt of one existing alert. + 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. -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 24c0cac4fa..14bd295aa3 100644 --- a/docs/command/atlas-api-alerts-getAlert.txt +++ b/docs/command/atlas-api-alerts-getAlert.txt @@ -12,10 +12,12 @@ atlas api alerts getAlert :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one alert.Returns one alert. + 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. -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 e34de2622d..6676be29df 100644 --- a/docs/command/atlas-api-alerts-listAlerts.txt +++ b/docs/command/atlas-api-alerts-listAlerts.txt @@ -12,10 +12,12 @@ atlas api alerts listAlerts :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all alerts.Returns all alerts. + 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. -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 c260e2576c..ef4ef06a5b 100644 --- a/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt +++ b/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt @@ -12,10 +12,12 @@ atlas api alerts listAlertsByAlertConfigurationId :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all open alerts that the specified alert configuration triggers.Returns all open alerts that the specified alert configuration triggers. + 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. -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 942d101b9a..dbf009a079 100644 --- a/docs/command/atlas-api-alerts.txt +++ b/docs/command/atlas-api-alerts.txt @@ -12,10 +12,12 @@ 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.Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. + 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. -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,22 +56,10 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alerts-acknowledgeAlert` - 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. - -Confirms receipt of one existing alert. -* :ref:`atlas-api-alerts-getAlert` - 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. - -Returns one alert. -* :ref:`atlas-api-alerts-listAlerts` - 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. - -Returns all alerts. -* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - 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. - -Returns all open alerts that the specified alert configuration triggers. +* :ref:`atlas-api-alerts-acknowledgeAlert` - `Public Preview: please provide feedback `_: Confirms receipt of one existing alert.Confirms receipt of one existing alert. +* :ref:`atlas-api-alerts-getAlert` - `Public Preview: please provide feedback `_: Returns one alert.Returns one alert. +* :ref:`atlas-api-alerts-listAlerts` - `Public Preview: please provide feedback `_: Returns all alerts.Returns all alerts. +* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - `Public Preview: please provide feedback `_: Returns all open alerts that the specified alert configuration triggers.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 21da8fe6c1..8b70f71ffc 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt @@ -12,10 +12,12 @@ atlas api atlasSearch createAtlasSearchDeployment :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates Search Nodes for the specified cluster.Creates Search Nodes for the specified cluster. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchDeployment. diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt index e7ff5ca048..bf92f3c6a3 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt @@ -12,10 +12,12 @@ atlas api atlasSearch createAtlasSearchIndex :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one Atlas Search index on the specified collection.Creates one Atlas Search index on the specified collection. + 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. -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 f444c6318b..e023e6c910 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt @@ -12,10 +12,12 @@ atlas api atlasSearch createAtlasSearchIndexDeprecated :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one Atlas Search index on the specified collection.Creates one Atlas Search index on the specified collection. + 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. -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 5417e75b6f..2def549fc7 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt @@ -12,10 +12,12 @@ atlas api atlasSearch deleteAtlasSearchDeployment :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Deletes the Search Nodes for the specified cluster.Deletes the Search Nodes for the specified cluster. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchDeployment. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt index 6a92b9b2cb..5021ff97e4 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt @@ -12,10 +12,12 @@ 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.Removes one Atlas Search index that you identified with its unique ID. + 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. -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 624a4b6130..e0c46edff3 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt @@ -12,10 +12,12 @@ 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.Removes one Atlas Search index that you identified with its database, collection, and name. + 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. -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 27eabafea0..6f3743feeb 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt @@ -12,10 +12,12 @@ 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.Removes one Atlas Search index that you identified with its unique ID. + 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. -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 450411ce07..60d4b4a609 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt @@ -12,10 +12,12 @@ atlas api atlasSearch getAtlasSearchDeployment :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the Search Nodes for the specified cluster.Returns the Search Nodes for the specified cluster. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchDeployment. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt index 10cf602f8b..07d33dd318 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt @@ -12,10 +12,12 @@ 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.Returns one Atlas Search index that you identified with its unique ID. + 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. -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 b68e230afc..797de038ce 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt @@ -12,10 +12,12 @@ 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.Returns one Atlas Search index that you identified with its database, collection name, and index name. + 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. -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 afee4a44f1..34ebff3629 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt @@ -12,10 +12,12 @@ atlas api atlasSearch getAtlasSearchIndexDeprecated :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one Atlas Search index in the specified project.Returns one Atlas Search index in the specified project. + 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. -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 0ae56d0119..a1a4328f74 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt @@ -12,10 +12,12 @@ atlas api atlasSearch listAtlasSearchIndexes :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified collection.Returns all Atlas Search indexes on the specified collection. + 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. -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 b37b310272..e8ce08f1a6 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt @@ -12,10 +12,12 @@ atlas api atlasSearch listAtlasSearchIndexesCluster :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified cluster.Returns all Atlas Search indexes on the specified cluster. + 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. -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 50df8a267c..a436ed03e5 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt @@ -12,10 +12,12 @@ atlas api atlasSearch listAtlasSearchIndexesDeprecated :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified collection.Returns all Atlas Search indexes on the specified collection. + 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. -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 2939a94cf3..1ad64e44d6 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt @@ -12,10 +12,12 @@ atlas api atlasSearch updateAtlasSearchDeployment :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates the Search Nodes for the specified cluster.Updates the Search Nodes for the specified cluster. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchDeployment. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt index 478ed9b966..2c5ce902b4 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt @@ -12,10 +12,12 @@ 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.Updates one Atlas Search index that you identified with its unique ID. + 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. -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 a4722443c2..57b1335899 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt @@ -12,10 +12,12 @@ 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.Updates one Atlas Search index that you identified with its database, collection name, and index name. + 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. -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 65502ac0e4..ec2fdccccf 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt @@ -12,10 +12,12 @@ 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.Updates one Atlas Search index that you identified with its unique ID. + 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. -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 063cbd17bb..b220e13029 100644 --- a/docs/command/atlas-api-atlasSearch.txt +++ b/docs/command/atlas-api-atlasSearch.txt @@ -12,10 +12,12 @@ atlas api atlasSearch :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster.Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. + 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. -Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. + Also returns and updates user-defined analyzers for the specified cluster. @@ -54,78 +56,24 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-atlasSearch-createAtlasSearchDeployment` - 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. - -Creates Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-createAtlasSearchIndex` - 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. - -Creates one Atlas Search index on the specified collection. -* :ref:`atlas-api-atlasSearch-createAtlasSearchIndexDeprecated` - 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. - -Creates one Atlas Search index on the specified collection. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchDeployment` - 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. - -Deletes the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndex` - 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. - -Removes one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexByName` - 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. - -Removes one Atlas Search index that you identified with its database, collection, and name. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated` - 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. - -Removes one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-getAtlasSearchDeployment` - 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. - -Returns the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndex` - 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. - -Returns one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexByName` - 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. - -Returns one Atlas Search index that you identified with its database, collection name, and index name. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexDeprecated` - 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. - -Returns one Atlas Search index in the specified project. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexes` - 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. - -Returns all Atlas Search indexes on the specified collection. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesCluster` - 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. - -Returns all Atlas Search indexes on the specified cluster. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated` - 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. - -Returns all Atlas Search indexes on the specified collection. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchDeployment` - 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. - -Updates the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndex` - 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. - -Updates one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexByName` - 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. - -Updates one Atlas Search index that you identified with its database, collection name, and index name. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated` - 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. - -Updates one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-createAtlasSearchDeployment` - `Public Preview: please provide feedback `_: Creates Search Nodes for the specified cluster.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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 c71964c4d9..83fb3d0b6a 100644 --- a/docs/command/atlas-api-auditing-getAuditingConfiguration.txt +++ b/docs/command/atlas-api-auditing-getAuditingConfiguration.txt @@ -12,10 +12,12 @@ atlas api auditing getAuditingConfiguration :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the auditing configuration for the specified project.Returns the auditing configuration for the specified project. + 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. -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 af022d2b14..683391db43 100644 --- a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt +++ b/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt @@ -12,10 +12,12 @@ atlas api auditing updateAuditingConfiguration :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates the auditing configuration for the specified project.Updates the auditing configuration for the specified project. + 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. -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 f192e3c5ac..78a75fa0ac 100644 --- a/docs/command/atlas-api-auditing.txt +++ b/docs/command/atlas-api-auditing.txt @@ -12,10 +12,14 @@ atlas api auditing :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns and edits database auditing settings for MongoDB Cloud projects.Returns and edits database auditing settings for MongoDB Cloud projects. + 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. -Returns and edits database auditing settings for MongoDB Cloud projects. + + + Options ------- @@ -52,14 +56,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-auditing-getAuditingConfiguration` - 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. - -Returns the auditing configuration for the specified project. -* :ref:`atlas-api-auditing-updateAuditingConfiguration` - 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. - -Updates the auditing configuration for the specified project. +* :ref:`atlas-api-auditing-getAuditingConfiguration` - `Public Preview: please provide feedback `_: Returns the auditing configuration for the specified project.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.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 7039431332..abeb3bae75 100644 --- a/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt +++ b/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt @@ -12,10 +12,12 @@ 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.Returns the custom DNS configuration for AWS clusters in the specified project. + 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. -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 830a7314c9..0c7e0f9b06 100644 --- a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt +++ b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt @@ -12,10 +12,12 @@ 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.Enables or disables the custom DNS configuration for AWS clusters in the specified project. + 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. -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 48d1c54a57..3df27fbe19 100644 --- a/docs/command/atlas-api-awsClustersDns.txt +++ b/docs/command/atlas-api-awsClustersDns.txt @@ -12,10 +12,12 @@ 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.Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. + 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. -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,14 +56,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-awsClustersDns-getAwsCustomDns` - 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. - -Returns the custom DNS configuration for AWS clusters in the specified project. -* :ref:`atlas-api-awsClustersDns-toggleAwsCustomDns` - 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. - -Enables or disables the custom DNS configuration for AWS clusters in the specified project. +* :ref:`atlas-api-awsClustersDns-getAwsCustomDns` - `Public Preview: please provide feedback `_: Returns the custom DNS configuration for AWS clusters in the specified project.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.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 ccbe52983e..9ae80039ef 100644 --- a/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt @@ -12,10 +12,12 @@ 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.Cancels one cloud backup restore job of one cluster from the specified project. + 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. -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 c45aced3ee..f133d2a6ee 100644 --- a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt +++ b/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt @@ -12,10 +12,12 @@ 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.Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. + 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. -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 757141a453..7599009a16 100644 --- a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt @@ -12,10 +12,12 @@ atlas api cloudBackups createBackupRestoreJob :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Restores one snapshot of one cluster from the specified project.Restores one snapshot of one cluster from the specified project. + 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. -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 043701fbaf..1cb742c2f8 100644 --- a/docs/command/atlas-api-cloudBackups-createExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-createExportBucket.txt @@ -12,10 +12,12 @@ 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.Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. + 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. -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 b886d48497..3fbeb06a1b 100644 --- a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt @@ -12,10 +12,12 @@ atlas api cloudBackups createServerlessBackupRestoreJob :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Restores one snapshot of one serverless instance from the specified project.Restores one snapshot of one serverless instance from the specified project. + 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. -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 a4514c7dc2..7f0e3f048e 100644 --- a/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt +++ b/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt @@ -12,10 +12,12 @@ atlas api cloudBackups deleteAllBackupSchedules :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes all cloud backup schedules for the specified cluster.Removes all cloud backup schedules for the specified cluster. + 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. -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 90dfaa78f7..8434394055 100644 --- a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt @@ -12,10 +12,12 @@ atlas api cloudBackups deleteExportBucket :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Deletes an Export Bucket.Deletes an Export Bucket. + 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. -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 d01443d65b..d6a6dec583 100644 --- a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt +++ b/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt @@ -12,10 +12,12 @@ atlas api cloudBackups deleteReplicaSetBackup :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes the specified snapshot.Removes the specified snapshot. + 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. -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 261284792c..943ac07ed6 100644 --- a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt +++ b/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt @@ -12,10 +12,12 @@ atlas api cloudBackups deleteShardedClusterBackup :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one snapshot of one sharded cluster from the specified project.Removes one snapshot of one sharded cluster from the specified project. + 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. -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 67117d5d21..380e52b837 100644 --- a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt @@ -12,10 +12,12 @@ atlas api cloudBackups disableDataProtectionSettings :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Disables the Backup Compliance Policy settings with the specified project.Disables the Backup Compliance Policy settings with the specified project. + 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. -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 edc17f8e53..dc261717b4 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt @@ -12,10 +12,12 @@ 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.Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. + 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. -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 285f01c209..cd0eae77c3 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt @@ -12,10 +12,12 @@ 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.Returns one cloud backup restore job for one cluster from the specified project. + 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. -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 0ab40faf69..16b140bfaf 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt @@ -12,10 +12,12 @@ 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.Returns the cloud backup schedule for the specified cluster within the specified project. + 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. -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 d9a89c5096..a9d2822e85 100644 --- a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt @@ -12,10 +12,12 @@ atlas api cloudBackups getDataProtectionSettings :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the Backup Compliance Policy settings with the specified project.Returns the Backup Compliance Policy settings with the specified project. + 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. -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 9623c68d99..148b56e27c 100644 --- a/docs/command/atlas-api-cloudBackups-getExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-getExportBucket.txt @@ -12,10 +12,12 @@ atlas api cloudBackups getExportBucket :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one Export Bucket associated with the specified Project.Returns one Export Bucket associated with the specified Project. + 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. -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 7f6ba8400f..259efed883 100644 --- a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt @@ -12,10 +12,12 @@ atlas api cloudBackups getReplicaSetBackup :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one snapshot from the specified cluster.Returns one snapshot from the specified cluster. + 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. -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 3480180bdf..37c57b649f 100644 --- a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt @@ -12,10 +12,12 @@ atlas api cloudBackups getServerlessBackup :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one snapshot of one serverless instance from the specified project.Returns one snapshot of one serverless instance from the specified project. + 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. -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 e72674f5b1..3a48e86dcc 100644 --- a/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt @@ -12,10 +12,12 @@ 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.Returns one restore job for one serverless instance from the specified project. + 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. -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 b16f8979a5..a0dca78e78 100644 --- a/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt @@ -12,10 +12,12 @@ atlas api cloudBackups getShardedClusterBackup :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one snapshot of one sharded cluster from the specified project.Returns one snapshot of one sharded cluster from the specified project. + 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. -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 1f58672ca1..ce8bc11457 100644 --- a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt @@ -12,10 +12,12 @@ 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.Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. + 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. -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 a70bed5d90..3a34e133c4 100644 --- a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt @@ -12,10 +12,12 @@ 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.Returns all cloud backup restore jobs for one cluster from the specified project. + 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. -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 fb533a2845..fd4384a4d1 100644 --- a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt +++ b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt @@ -12,10 +12,12 @@ atlas api cloudBackups listExportBuckets :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all Export Buckets associated with the specified Project.Returns all Export Buckets associated with the specified Project. + 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. -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 f4d5267e79..a7b74362ac 100644 --- a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt @@ -12,10 +12,12 @@ atlas api cloudBackups listReplicaSetBackups :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all snapshots of one cluster from the specified project.Returns all snapshots of one cluster from the specified project. + 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. -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 a191443fd0..67dbad2a23 100644 --- a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt @@ -12,10 +12,12 @@ 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.Returns all restore jobs for one serverless instance from the specified project. + 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. -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 9985f66017..1955f9a938 100644 --- a/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt @@ -12,10 +12,12 @@ atlas api cloudBackups listServerlessBackups :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all snapshots of one serverless instance from the specified project.Returns all snapshots of one serverless instance from the specified project. + 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. -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 98b6baeb25..4a8c834da4 100644 --- a/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt @@ -12,10 +12,12 @@ atlas api cloudBackups listShardedClusterBackups :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all snapshots of one sharded cluster from the specified project.Returns all snapshots of one sharded cluster from the specified project. + 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. -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 bb59aaebe5..96b2ff50ef 100644 --- a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt +++ b/docs/command/atlas-api-cloudBackups-takeSnapshot.txt @@ -12,10 +12,12 @@ atlas api cloudBackups takeSnapshot :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Takes one on-demand snapshot for the specified cluster.Takes one on-demand snapshot for the specified cluster. + 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. -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 ef29552fe4..a29c34e0ed 100644 --- a/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt +++ b/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt @@ -12,10 +12,12 @@ 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.Updates the cloud backup schedule for one cluster within the specified project. + 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. -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 ead854f513..7dc0208ed4 100644 --- a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt @@ -12,10 +12,12 @@ atlas api cloudBackups updateDataProtectionSettings :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates the Backup Compliance Policy settings for the specified project.Updates the Backup Compliance Policy settings for the specified project. + 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. -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 fd215c15b1..b455f718f5 100644 --- a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt +++ b/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt @@ -12,10 +12,12 @@ 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.Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. + 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. -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 372027a72c..39a31a91ac 100644 --- a/docs/command/atlas-api-cloudBackups.txt +++ b/docs/command/atlas-api-cloudBackups.txt @@ -12,10 +12,12 @@ atlas api cloudBackups :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules.Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. + 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. -Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. + This resource applies only to clusters that use Cloud Backups. @@ -54,126 +56,36 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudBackups-cancelBackupRestoreJob` - 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. - -Cancels one cloud backup restore job of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-createBackupExportJob` - 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. - -Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. -* :ref:`atlas-api-cloudBackups-createBackupRestoreJob` - 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. - -Restores one snapshot of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-createExportBucket` - 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. - -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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. -* :ref:`atlas-api-cloudBackups-deleteAllBackupSchedules` - 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. - -Removes all cloud backup schedules for the specified cluster. -* :ref:`atlas-api-cloudBackups-deleteExportBucket` - 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. - -Deletes an Export Bucket. -* :ref:`atlas-api-cloudBackups-deleteReplicaSetBackup` - 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. - -Removes the specified snapshot. -* :ref:`atlas-api-cloudBackups-deleteShardedClusterBackup` - 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. - -Removes one snapshot of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-disableDataProtectionSettings` - 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. - -Disables the Backup Compliance Policy settings with the specified project. -* :ref:`atlas-api-cloudBackups-getBackupExportJob` - 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. - -Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. -* :ref:`atlas-api-cloudBackups-getBackupRestoreJob` - 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. - -Returns one cloud backup restore job for one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-getBackupSchedule` - 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. - -Returns the cloud backup schedule for the specified cluster within the specified project. -* :ref:`atlas-api-cloudBackups-getDataProtectionSettings` - 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. - -Returns the Backup Compliance Policy settings with the specified project. -* :ref:`atlas-api-cloudBackups-getExportBucket` - 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. - -Returns one Export Bucket associated with the specified Project. -* :ref:`atlas-api-cloudBackups-getReplicaSetBackup` - 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. - -Returns one snapshot from the specified cluster. -* :ref:`atlas-api-cloudBackups-getServerlessBackup` - 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. - -Returns one snapshot of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-getServerlessBackupRestoreJob` - 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. - -Returns one restore job for one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-getShardedClusterBackup` - 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. - -Returns one snapshot of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listBackupExportJobs` - 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. - -Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. -* :ref:`atlas-api-cloudBackups-listBackupRestoreJobs` - 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. - -Returns all cloud backup restore jobs for one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listExportBuckets` - 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. - -Returns all Export Buckets associated with the specified Project. -* :ref:`atlas-api-cloudBackups-listReplicaSetBackups` - 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. - -Returns all snapshots of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listServerlessBackupRestoreJobs` - 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. - -Returns all restore jobs for one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-listServerlessBackups` - 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. - -Returns all snapshots of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-listShardedClusterBackups` - 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. - -Returns all snapshots of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-takeSnapshot` - 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. - -Takes one on-demand snapshot for the specified cluster. -* :ref:`atlas-api-cloudBackups-updateBackupSchedule` - 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. - -Updates the cloud backup schedule for one cluster within the specified project. -* :ref:`atlas-api-cloudBackups-updateDataProtectionSettings` - 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. - -Updates the Backup Compliance Policy settings for the specified project. -* :ref:`atlas-api-cloudBackups-updateSnapshotRetention` - 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. - -Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-cloudBackups-cancelBackupRestoreJob` - `Public Preview: please provide feedback `_: Cancels one cloud backup restore job of one cluster from the specified project.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.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.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.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.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.Removes all cloud backup schedules for the specified cluster. +* :ref:`atlas-api-cloudBackups-deleteExportBucket` - `Public Preview: please provide feedback `_: Deletes an Export Bucket.Deletes an Export Bucket. +* :ref:`atlas-api-cloudBackups-deleteReplicaSetBackup` - `Public Preview: please provide feedback `_: Removes the specified snapshot.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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 c4e9e70e8b..ec16ea3d1c 100644 --- a/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt +++ b/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt @@ -12,10 +12,12 @@ 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.Create one link-token that contains all the information required to complete the link. + 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. -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 1679333715..54ec6ec610 100644 --- a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt @@ -12,10 +12,12 @@ 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.Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. + 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. -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 f13e7c2b92..e5a08a096d 100644 --- a/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt @@ -12,10 +12,12 @@ atlas api cloudMigrationService cutoverMigration :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Cut over the migrated cluster to MongoDB Atlas.Cut over the migrated cluster to MongoDB Atlas. + 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. -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 ba633fcc51..b188653666 100644 --- a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt +++ b/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt @@ -12,10 +12,12 @@ atlas api cloudMigrationService deleteLinkToken :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Remove one organization link and its associated public API key.Remove one organization link and its associated public API key. + 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. -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 6286638eb5..b782dae7ee 100644 --- a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt @@ -12,10 +12,12 @@ atlas api cloudMigrationService getPushMigration :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Return details of one cluster migration job.Return details of one cluster migration job. + 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. -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 2825a92d3b..f95b21069a 100644 --- a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt +++ b/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt @@ -12,10 +12,12 @@ atlas api cloudMigrationService getValidationStatus :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Return the status of one migration validation job.Return the status of one migration validation job. + 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. -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 fe90434b6d..3753a7db9a 100644 --- a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt +++ b/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt @@ -12,10 +12,12 @@ atlas api cloudMigrationService listSourceProjects :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Return all projects that you can migrate to the specified organization.Return all projects that you can migrate to the specified organization. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/listSourceProjects. diff --git a/docs/command/atlas-api-cloudMigrationService-validateMigration.txt b/docs/command/atlas-api-cloudMigrationService-validateMigration.txt index ea8897e3e3..54228f2b15 100644 --- a/docs/command/atlas-api-cloudMigrationService-validateMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-validateMigration.txt @@ -12,10 +12,12 @@ 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.Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. + 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. -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 66859a470a..b2aa37423e 100644 --- a/docs/command/atlas-api-cloudMigrationService.txt +++ b/docs/command/atlas-api-cloudMigrationService.txt @@ -12,10 +12,12 @@ atlas api cloudMigrationService :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Manages the Cloud Migration Service.Manages the Cloud Migration Service. + 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. -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,38 +56,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudMigrationService-createLinkToken` - 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. - -Create one link-token that contains all the information required to complete the link. -* :ref:`atlas-api-cloudMigrationService-createPushMigration` - 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. - -Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. -* :ref:`atlas-api-cloudMigrationService-cutoverMigration` - 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. - -Cut over the migrated cluster to MongoDB Atlas. -* :ref:`atlas-api-cloudMigrationService-deleteLinkToken` - 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. - -Remove one organization link and its associated public API key. -* :ref:`atlas-api-cloudMigrationService-getPushMigration` - 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. - -Return details of one cluster migration job. -* :ref:`atlas-api-cloudMigrationService-getValidationStatus` - 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. - -Return the status of one migration validation job. -* :ref:`atlas-api-cloudMigrationService-listSourceProjects` - 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. - -Return all projects that you can migrate to the specified organization. -* :ref:`atlas-api-cloudMigrationService-validateMigration` - 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. - -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` - `Public Preview: please provide feedback `_: Create one link-token that contains all the information required to complete the link.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.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.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.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.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.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.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.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 7be61ef6bf..9bc787c199 100644 --- a/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt @@ -12,10 +12,12 @@ atlas api cloudProviderAccess authorizeCloudProviderAccessRole :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Grants access to the specified project for the specified access role.Grants access to the specified project for the specified access role. + 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. -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 6d4160ace9..b65b3e1587 100644 --- a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt @@ -12,10 +12,12 @@ atlas api cloudProviderAccess createCloudProviderAccessRole :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one access role for the specified cloud provider.Creates one access role for the specified cloud provider. + 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. -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. diff --git a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt index 1938478ed3..9a773ccd9e 100644 --- a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt @@ -12,10 +12,12 @@ atlas api cloudProviderAccess deauthorizeCloudProviderAccessRole :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Revokes access to the specified project for the specified access role.Revokes access to the specified project for the specified access role. + 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. -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 940284544b..8ca9b3aaf6 100644 --- a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt @@ -12,10 +12,12 @@ 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.Returns the access role with the specified id and with access to the specified project. + 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. -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 234d675184..248b4b0b5f 100644 --- a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt +++ b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt @@ -12,10 +12,12 @@ 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.Returns all cloud provider access roles with access to the specified project. + 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. -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 843eeffb81..fb9ea534b7 100644 --- a/docs/command/atlas-api-cloudProviderAccess.txt +++ b/docs/command/atlas-api-cloudProviderAccess.txt @@ -12,10 +12,14 @@ atlas api cloudProviderAccess :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas.Returns, adds, authorizes, and removes AWS IAM roles in Atlas. + 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. -Returns, adds, authorizes, and removes AWS IAM roles in Atlas. + + + Options ------- @@ -52,26 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole` - 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. - -Grants access to the specified project for the specified access role. -* :ref:`atlas-api-cloudProviderAccess-createCloudProviderAccessRole` - 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. - -Creates one access role for the specified cloud provider. -* :ref:`atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole` - 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. - -Revokes access to the specified project for the specified access role. -* :ref:`atlas-api-cloudProviderAccess-getCloudProviderAccessRole` - 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. - -Returns the access role with the specified id and with access to the specified project. -* :ref:`atlas-api-cloudProviderAccess-listCloudProviderAccessRoles` - 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. - -Returns all cloud provider access roles with access to the specified project. +* :ref:`atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole` - `Public Preview: please provide feedback `_: Grants access to the specified project for the specified access role.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.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.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.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.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 1d6439046c..9298a72e8d 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt @@ -12,10 +12,12 @@ atlas api clusterOutageSimulation endOutageSimulation :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Ends a cluster outage simulation.Ends a cluster outage simulation. + 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. -Ends a cluster outage simulation. + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/endOutageSimulation. diff --git a/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt index a1a2486886..eff0f4e162 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt @@ -12,10 +12,12 @@ atlas api clusterOutageSimulation getOutageSimulation :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one outage simulation for one cluster.Returns one outage simulation for one cluster. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/getOutageSimulation. diff --git a/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt index 5749749449..feec5beaa5 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt @@ -12,10 +12,12 @@ atlas api clusterOutageSimulation startOutageSimulation :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Starts a cluster outage simulation.Starts a cluster outage simulation. + 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. -Starts a cluster outage simulation. + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/startOutageSimulation. diff --git a/docs/command/atlas-api-clusterOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation.txt index a905e184b4..d3b8828647 100644 --- a/docs/command/atlas-api-clusterOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation.txt @@ -12,10 +12,14 @@ atlas api clusterOutageSimulation :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, starts, or ends a cluster outage simulation.Returns, starts, or ends a cluster outage simulation. + 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. -Returns, starts, or ends a cluster outage simulation. + + + Options ------- @@ -52,18 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-clusterOutageSimulation-endOutageSimulation` - 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. - -Ends a cluster outage simulation. -* :ref:`atlas-api-clusterOutageSimulation-getOutageSimulation` - 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. - -Returns one outage simulation for one cluster. -* :ref:`atlas-api-clusterOutageSimulation-startOutageSimulation` - 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. - -Starts a cluster outage simulation. +* :ref:`atlas-api-clusterOutageSimulation-endOutageSimulation` - `Public Preview: please provide feedback `_: Ends a cluster outage simulation.Ends a cluster outage simulation. +* :ref:`atlas-api-clusterOutageSimulation-getOutageSimulation` - `Public Preview: please provide feedback `_: Returns one outage simulation for one cluster.Returns one outage simulation for one cluster. +* :ref:`atlas-api-clusterOutageSimulation-startOutageSimulation` - `Public Preview: please provide feedback `_: Starts a cluster outage simulation.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 865baaf4c0..bbb07bc404 100644 --- a/docs/command/atlas-api-clusters-autoScalingConfiguration.txt +++ b/docs/command/atlas-api-clusters-autoScalingConfiguration.txt @@ -12,10 +12,12 @@ atlas api clusters autoScalingConfiguration :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the internal configuration of AutoScaling for sharded clusters.Returns the internal configuration of AutoScaling for sharded clusters. + 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. -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 c025b4784f..1f444905b7 100644 --- a/docs/command/atlas-api-clusters-createCluster.txt +++ b/docs/command/atlas-api-clusters-createCluster.txt @@ -12,10 +12,12 @@ atlas api clusters createCluster :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one cluster in the specified project.Creates one cluster in the specified project. + 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. -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 8ee83b29e0..3b5f1b79fb 100644 --- a/docs/command/atlas-api-clusters-deleteCluster.txt +++ b/docs/command/atlas-api-clusters-deleteCluster.txt @@ -12,10 +12,12 @@ atlas api clusters deleteCluster :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one cluster from the specified project.Removes one cluster from the specified project. + 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. -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 ba3368dc33..3c94cd8c8a 100644 --- a/docs/command/atlas-api-clusters-getCluster.txt +++ b/docs/command/atlas-api-clusters-getCluster.txt @@ -12,10 +12,12 @@ atlas api clusters getCluster :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the details for one cluster in the specified project.Returns the details for one cluster in the specified project. + 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. -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 5ea98523a5..7cbc372362 100644 --- a/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt +++ b/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt @@ -12,10 +12,12 @@ 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.Returns the advanced configuration details for one cluster in the specified project. + 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. -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 7bb1e0f6c9..16c95bad13 100644 --- a/docs/command/atlas-api-clusters-getClusterStatus.txt +++ b/docs/command/atlas-api-clusters-getClusterStatus.txt @@ -12,10 +12,12 @@ 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.Returns the status of all changes that you made to the specified cluster in the specified project. + 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. -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 1f26c9ae42..b9c5fb2f85 100644 --- a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt +++ b/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt @@ -12,10 +12,12 @@ atlas api clusters getSampleDatasetLoadStatus :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Checks the progress of loading the sample dataset into one cluster.Checks the progress of loading the sample dataset into one cluster. + 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. -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 29a4ce5905..4d7be2decb 100644 --- a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt +++ b/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt @@ -12,10 +12,12 @@ 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.Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/grantMongoDbEmployeeAccess. diff --git a/docs/command/atlas-api-clusters-listCloudProviderRegions.txt b/docs/command/atlas-api-clusters-listCloudProviderRegions.txt index 5c5aaa16f2..fbd8aed290 100644 --- a/docs/command/atlas-api-clusters-listCloudProviderRegions.txt +++ b/docs/command/atlas-api-clusters-listCloudProviderRegions.txt @@ -12,10 +12,12 @@ 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.Returns the list of regions available for the specified cloud provider at the specified tier. + 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. -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 a7021b24c0..236b458891 100644 --- a/docs/command/atlas-api-clusters-listClusters.txt +++ b/docs/command/atlas-api-clusters-listClusters.txt @@ -12,10 +12,12 @@ 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.Returns the details for all clusters in the specific project to which you have 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. -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 a3f08b89f6..4a9a4611b9 100644 --- a/docs/command/atlas-api-clusters-listClustersForAllProjects.txt +++ b/docs/command/atlas-api-clusters-listClustersForAllProjects.txt @@ -12,10 +12,12 @@ 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.Returns the details for all clusters in all projects to which you have 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. -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 966659747b..496825dfef 100644 --- a/docs/command/atlas-api-clusters-loadSampleDataset.txt +++ b/docs/command/atlas-api-clusters-loadSampleDataset.txt @@ -12,10 +12,12 @@ atlas api clusters loadSampleDataset :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Requests loading the MongoDB sample dataset into the specified cluster.Requests loading the MongoDB sample dataset into the specified cluster. + 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. -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 538bf304d4..3b921efef5 100644 --- a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt +++ b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt @@ -12,10 +12,12 @@ 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.Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. + 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. -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 e8f9a4ac5d..39f5a66e69 100644 --- a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt +++ b/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt @@ -12,10 +12,12 @@ atlas api clusters revokeMongoDbEmployeeAccess :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Revokes a previously granted MongoDB employee cluster access.Revokes a previously granted MongoDB employee cluster 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. -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/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/revokeMongoDbEmployeeAccess. diff --git a/docs/command/atlas-api-clusters-testFailover.txt b/docs/command/atlas-api-clusters-testFailover.txt index f99776d74c..79210eb925 100644 --- a/docs/command/atlas-api-clusters-testFailover.txt +++ b/docs/command/atlas-api-clusters-testFailover.txt @@ -12,10 +12,12 @@ 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.Starts a failover test for the specified cluster in the specified project. + 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. -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 e52e73c49b..1e9bc88957 100644 --- a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt +++ b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt @@ -12,10 +12,12 @@ atlas api clusters unpinFeatureCompatibilityVersion :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Unpins the current fixed Feature Compatibility Version (FCV).Unpins the current fixed Feature Compatibility Version (FCV). + 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. -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 4c824e74af..4d4978ee27 100644 --- a/docs/command/atlas-api-clusters-updateCluster.txt +++ b/docs/command/atlas-api-clusters-updateCluster.txt @@ -12,10 +12,12 @@ atlas api clusters updateCluster :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates the details for one cluster in the specified project.Updates the details for one cluster in the specified project. + 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. -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 bec3a00272..cc292bdb8b 100644 --- a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt +++ b/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt @@ -12,10 +12,12 @@ 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.Updates the advanced configuration details for one cluster in the specified project. + 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. -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 a8e471cbc3..df04f7fa5f 100644 --- a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt +++ b/docs/command/atlas-api-clusters-upgradeSharedCluster.txt @@ -12,10 +12,12 @@ 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.Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. + 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. -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 08bfffa7ac..b185bbf340 100644 --- a/docs/command/atlas-api-clusters.txt +++ b/docs/command/atlas-api-clusters.txt @@ -12,10 +12,12 @@ atlas api clusters :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes database deployments.Returns, adds, edits, and removes database deployments. + 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. -Returns, adds, edits, and removes database deployments. + Changes to cluster configurations can affect costs. This resource requires your Project ID. @@ -54,82 +56,25 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-clusters-autoScalingConfiguration` - 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. - -Returns the internal configuration of AutoScaling for sharded clusters. -* :ref:`atlas-api-clusters-createCluster` - 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. - -Creates one cluster in the specified project. -* :ref:`atlas-api-clusters-deleteCluster` - 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. - -Removes one cluster from the specified project. -* :ref:`atlas-api-clusters-getCluster` - 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. - -Returns the details for one cluster in the specified project. -* :ref:`atlas-api-clusters-getClusterAdvancedConfiguration` - 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. - -Returns the advanced configuration details for one cluster in the specified project. -* :ref:`atlas-api-clusters-getClusterStatus` - 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. - -Returns the status of all changes that you made to the specified cluster in the specified project. -* :ref:`atlas-api-clusters-getSampleDatasetLoadStatus` - 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. - -Checks the progress of loading the sample dataset into one cluster. -* :ref:`atlas-api-clusters-grantMongoDbEmployeeAccess` - 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. - -Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. -* :ref:`atlas-api-clusters-listCloudProviderRegions` - 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. - -Returns the list of regions available for the specified cloud provider at the specified tier. -* :ref:`atlas-api-clusters-listClusters` - 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. - -Returns the details for all clusters in the specific project to which you have access. -* :ref:`atlas-api-clusters-listClustersForAllProjects` - 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. - -Returns the details for all clusters in all projects to which you have access. -* :ref:`atlas-api-clusters-loadSampleDataset` - 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. - -Requests loading the MongoDB sample dataset into the specified cluster. -* :ref:`atlas-api-clusters-pinFeatureCompatibilityVersion` - 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. - -Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. -* :ref:`atlas-api-clusters-revokeMongoDbEmployeeAccess` - 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. - -Revokes a previously granted MongoDB employee cluster access. -* :ref:`atlas-api-clusters-testFailover` - 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. - -Starts a failover test for the specified cluster in the specified project. -* :ref:`atlas-api-clusters-unpinFeatureCompatibilityVersion` - 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. - -Unpins the current fixed Feature Compatibility Version (FCV). -* :ref:`atlas-api-clusters-updateCluster` - 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. - -Updates the details for one cluster in the specified project. -* :ref:`atlas-api-clusters-updateClusterAdvancedConfiguration` - 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. - -Updates the advanced configuration details for one cluster in the specified project. -* :ref:`atlas-api-clusters-upgradeSharedCluster` - 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. - -Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. +* :ref:`atlas-api-clusters-autoScalingConfiguration` - `Public Preview: please provide feedback `_: Returns the internal configuration of AutoScaling for sharded clusters.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.Creates one cluster in the specified project. +* :ref:`atlas-api-clusters-deleteCluster` - `Public Preview: please provide feedback `_: Removes one cluster from the specified project.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.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.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.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.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.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.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.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.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.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.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.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.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).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.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.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.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 ca6cdffc0d..91d4a8c4c0 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt @@ -12,10 +12,12 @@ 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.Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceClusterMeasurements. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt index 22c6f4eb7a..390e689afd 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt @@ -12,10 +12,12 @@ 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.Get a list of the Coll Stats Latency process-level measurements for the given namespace. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceHostMeasurements. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt index 62b8966759..370bad5d85 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt @@ -12,10 +12,12 @@ 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.Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceMetrics. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt index bf9d728080..6fd736f44c 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt @@ -12,10 +12,12 @@ 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.Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForCluster. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt index 4ee5f712d7..0f14babad4 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt @@ -12,10 +12,12 @@ 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.Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForHost. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt index 682e254165..2a217d97e4 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt @@ -12,10 +12,12 @@ 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.Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getPinnedNamespaces. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt index 64f10f4862..c7f0594538 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt @@ -12,10 +12,12 @@ 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.Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPatch. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt index d3c41e77ce..b3fcde1ec2 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt @@ -12,10 +12,12 @@ 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.Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. + 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. -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 e5d58f97b0..50b17039f2 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt @@ -12,10 +12,12 @@ 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.Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/unpinNamespaces. diff --git a/docs/command/atlas-api-collectionLevelMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics.txt index a4e805c586..4ef0c611bb 100644 --- a/docs/command/atlas-api-collectionLevelMetrics.txt +++ b/docs/command/atlas-api-collectionLevelMetrics.txt @@ -12,10 +12,12 @@ atlas api collectionLevelMetrics :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, and edits pinned namespaces for the specified cluster or process.Returns, adds, and edits pinned namespaces for the specified cluster or process. + 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. -Returns, adds, and edits pinned namespaces for the specified cluster or process. + Also returns collection level latency metric data. @@ -54,42 +56,15 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements` - 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. - -Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements` - 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. - -Get a list of the Coll Stats Latency process-level measurements for the given namespace. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics` - 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. - -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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost` - 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. - -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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. -* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPatch` - 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. - -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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. -* :ref:`atlas-api-collectionLevelMetrics-unpinNamespaces` - 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. - -Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +* :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.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.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.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.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.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.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.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.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.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 a2bd7229eb..aceb1e0368 100644 --- a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt @@ -12,10 +12,12 @@ atlas api customDatabaseRoles createCustomDatabaseRole :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one custom role in the specified project.Creates one custom role in the specified project. + 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. -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 08d3f84fdf..248f77a3de 100644 --- a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt @@ -12,10 +12,12 @@ atlas api customDatabaseRoles deleteCustomDatabaseRole :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one custom role from the specified project.Removes one custom role from the specified project. + 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. -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 7914bc0f29..343e291df7 100644 --- a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt @@ -12,10 +12,12 @@ atlas api customDatabaseRoles getCustomDatabaseRole :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one custom role for the specified project.Returns one custom role for the specified project. + 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. -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 3084ced022..1c635389e2 100644 --- a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt +++ b/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt @@ -12,10 +12,12 @@ atlas api customDatabaseRoles listCustomDatabaseRoles :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all custom roles for the specified project.Returns all custom roles for the specified project. + 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. -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 b87886e8ba..1e6a1a1420 100644 --- a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt @@ -12,10 +12,12 @@ atlas api customDatabaseRoles updateCustomDatabaseRole :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates one custom role in the specified project.Updates one custom role in the specified project. + 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. -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 b6ea6ac22d..bb1d33f50e 100644 --- a/docs/command/atlas-api-customDatabaseRoles.txt +++ b/docs/command/atlas-api-customDatabaseRoles.txt @@ -12,10 +12,12 @@ atlas api customDatabaseRoles :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes custom database user privilege roles.Returns, adds, edits, and removes custom database user privilege roles. + 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. -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,26 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-customDatabaseRoles-createCustomDatabaseRole` - 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. - -Creates one custom role in the specified project. -* :ref:`atlas-api-customDatabaseRoles-deleteCustomDatabaseRole` - 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. - -Removes one custom role from the specified project. -* :ref:`atlas-api-customDatabaseRoles-getCustomDatabaseRole` - 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. - -Returns one custom role for the specified project. -* :ref:`atlas-api-customDatabaseRoles-listCustomDatabaseRoles` - 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. - -Returns all custom roles for the specified project. -* :ref:`atlas-api-customDatabaseRoles-updateCustomDatabaseRole` - 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. - -Updates one custom role in the specified project. +* :ref:`atlas-api-customDatabaseRoles-createCustomDatabaseRole` - `Public Preview: please provide feedback `_: Creates one custom role in the specified project.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.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.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.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.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 d8b4d5e17a..103c461fd5 100644 --- a/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt @@ -12,10 +12,12 @@ 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.Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. + 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. -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 43c09f2d30..3d1fde0e50 100644 --- a/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt @@ -12,10 +12,12 @@ atlas api dataFederation createFederatedDatabase :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one federated database instance in the specified project.Creates one federated database instance in the specified project. + 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. -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 070038bca1..a3ade74df3 100644 --- a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt @@ -12,10 +12,12 @@ atlas api dataFederation createOneDataFederationQueryLimit :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates or updates one query limit for one federated database instance.Creates or updates one query limit for one federated database instance. + 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. -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 3a57eb3a0b..5dc8c637f2 100644 --- a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt @@ -12,10 +12,12 @@ 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.Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. + 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. -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 bc6c60fe98..ccbbdd432f 100644 --- a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt @@ -12,10 +12,12 @@ atlas api dataFederation deleteFederatedDatabase :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one federated database instance from the specified project.Removes one federated database instance from the specified project. + 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. -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 67f492ca9c..482518e697 100644 --- a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt @@ -12,10 +12,12 @@ atlas api dataFederation deleteOneDataFederationInstanceQueryLimit :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Deletes one query limit for one federated database instance.Deletes one query limit for one federated database instance. + 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. -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 99d17c7926..5d54879c36 100644 --- a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt +++ b/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt @@ -12,10 +12,12 @@ atlas api dataFederation downloadFederatedDatabaseQueryLogs :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Downloads the query logs for the specified federated database instance.Downloads the query logs for the specified federated database instance. + 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. -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 5b220e0a8f..fdf5766498 100644 --- a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt @@ -12,10 +12,12 @@ 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.Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. + 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. -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 87b63ee2a3..c88431edb8 100644 --- a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt @@ -12,10 +12,12 @@ 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.Returns the details of one federated database instance within the specified project. + 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. -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 9341739fed..ca32009c2e 100644 --- a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt +++ b/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt @@ -12,10 +12,12 @@ 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.Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. + 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. -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 9db56d6b4f..2a81f40e75 100644 --- a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt +++ b/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt @@ -12,10 +12,12 @@ 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.Returns the details of all federated database instances in the specified project. + 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. -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 75dbbc3c1c..e56216a806 100644 --- a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt @@ -12,10 +12,12 @@ 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.Returns the details of one query limit for the specified federated database instance in the specified project. + 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. -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 d06a6e69d3..6c663fa42c 100644 --- a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt +++ b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt @@ -12,10 +12,12 @@ 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.Returns query limits for a federated databases instance in the specified project. + 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. -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 c66e79703e..e3cd4e4e9e 100644 --- a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt @@ -12,10 +12,12 @@ 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.Updates the details of one federated database instance in the specified project. + 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. -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 596eea538d..0780a5e25c 100644 --- a/docs/command/atlas-api-dataFederation.txt +++ b/docs/command/atlas-api-dataFederation.txt @@ -12,10 +12,12 @@ atlas api dataFederation :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes Federated Database Instances.Returns, adds, edits, and removes Federated Database Instances. + 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. -Returns, adds, edits, and removes Federated Database Instances. + This resource requires your project ID. Changes to federated database instance configurations can affect costs. @@ -54,62 +56,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-dataFederation-createDataFederationPrivateEndpoint` - 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. - -Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. -* :ref:`atlas-api-dataFederation-createFederatedDatabase` - 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. - -Creates one federated database instance in the specified project. -* :ref:`atlas-api-dataFederation-createOneDataFederationQueryLimit` - 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. - -Creates or updates one query limit for one federated database instance. -* :ref:`atlas-api-dataFederation-deleteDataFederationPrivateEndpoint` - 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. - -Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-deleteFederatedDatabase` - 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. - -Removes one federated database instance from the specified project. -* :ref:`atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit` - 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. - -Deletes one query limit for one federated database instance. -* :ref:`atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs` - 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. - -Downloads the query logs for the specified federated database instance. -* :ref:`atlas-api-dataFederation-getDataFederationPrivateEndpoint` - 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. - -Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-getFederatedDatabase` - 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. - -Returns the details of one federated database instance within the specified project. -* :ref:`atlas-api-dataFederation-listDataFederationPrivateEndpoints` - 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. - -Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-listFederatedDatabases` - 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. - -Returns the details of all federated database instances in the specified project. -* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimit` - 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. - -Returns the details of one query limit for the specified federated database instance in the specified project. -* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimits` - 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. - -Returns query limits for a federated databases instance in the specified project. -* :ref:`atlas-api-dataFederation-updateFederatedDatabase` - 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. - -Updates the details of one federated database instance in the specified project. +* :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.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.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.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.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.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.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.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.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.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.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.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.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.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.Updates the details of one federated database instance in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-dataLakePipelines-createPipeline.txt b/docs/command/atlas-api-dataLakePipelines-createPipeline.txt index 95467db832..16500b8ace 100644 --- a/docs/command/atlas-api-dataLakePipelines-createPipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-createPipeline.txt @@ -12,10 +12,12 @@ atlas api dataLakePipelines createPipeline :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one Data Lake Pipeline.Creates one Data Lake Pipeline. + 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. -Creates one Data Lake Pipeline. + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/createPipeline. diff --git a/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt b/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt index f1c37c01fb..3b5885e7fa 100644 --- a/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt @@ -12,10 +12,12 @@ atlas api dataLakePipelines deletePipeline :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one Data Lake Pipeline.Removes one Data Lake Pipeline. + 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. -Removes one Data Lake Pipeline. + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipeline. diff --git a/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt b/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt index 20b077da01..d1763f568f 100644 --- a/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt +++ b/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt @@ -12,10 +12,12 @@ atlas api dataLakePipelines deletePipelineRunDataset :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Deletes dataset that Atlas generated during the specified pipeline run.Deletes dataset that Atlas generated during the specified pipeline run. + 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. -Deletes dataset that Atlas generated during the specified pipeline run. + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipelineRunDataset. diff --git a/docs/command/atlas-api-dataLakePipelines-getPipeline.txt b/docs/command/atlas-api-dataLakePipelines-getPipeline.txt index 286fd30a98..2baef106d9 100644 --- a/docs/command/atlas-api-dataLakePipelines-getPipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-getPipeline.txt @@ -12,10 +12,12 @@ atlas api dataLakePipelines getPipeline :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the details of one Data Lake Pipeline within the specified project.Returns the details of one Data Lake Pipeline within the specified project. + 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. -Returns the details of one Data Lake Pipeline within the specified project. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt b/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt index d5eb4716b9..4175adf223 100644 --- a/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt +++ b/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt @@ -12,10 +12,12 @@ atlas api dataLakePipelines getPipelineRun :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the details of one Data Lake Pipeline run within the specified project.Returns the details of one Data Lake Pipeline run within the specified project. + 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. -Returns the details of one Data Lake Pipeline run within the specified project. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt index e0d5f06dc5..bbec3bbc76 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt @@ -12,10 +12,12 @@ atlas api dataLakePipelines listPipelineRuns :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns a list of past Data Lake Pipeline runs.Returns a list of past Data Lake Pipeline runs. + 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. -Returns a list of past Data Lake Pipeline runs. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt index 8aa9b79ed4..bf9424520f 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt @@ -12,10 +12,12 @@ atlas api dataLakePipelines listPipelineSchedules :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source.Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. + 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. -Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt index cbf8385c79..dd6aaaf6aa 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt @@ -12,10 +12,12 @@ atlas api dataLakePipelines listPipelineSnapshots :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run.Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. + 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. -Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelines.txt b/docs/command/atlas-api-dataLakePipelines-listPipelines.txt index c217da3888..159c1ba677 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelines.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelines.txt @@ -12,10 +12,12 @@ atlas api dataLakePipelines listPipelines :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns a list of Data Lake Pipelines.Returns a list of Data Lake Pipelines. + 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. -Returns a list of Data Lake Pipelines. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt b/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt index cf2e555711..2051817950 100644 --- a/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt @@ -12,10 +12,12 @@ atlas api dataLakePipelines pausePipeline :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Pauses ingestion for a Data Lake Pipeline within the specified project.Pauses ingestion for a Data Lake Pipeline within the specified project. + 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. -Pauses ingestion for a Data Lake Pipeline within the specified project. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt b/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt index 8bfc108ec2..e288100b4e 100644 --- a/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt @@ -12,10 +12,12 @@ atlas api dataLakePipelines resumePipeline :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Resumes ingestion for a Data Lake Pipeline within the specified project.Resumes ingestion for a Data Lake Pipeline within the specified project. + 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. -Resumes ingestion for a Data Lake Pipeline within the specified project. + To use this resource, the requesting Service Account or API Key must have the Project Read Only role. diff --git a/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt b/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt index 26237af27f..a1844c8e00 100644 --- a/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt +++ b/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt @@ -12,10 +12,12 @@ atlas api dataLakePipelines triggerSnapshotIngestion :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Triggers a Data Lake Pipeline ingestion of a specified snapshot.Triggers a Data Lake Pipeline ingestion of a specified snapshot. + 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. -Triggers a Data Lake Pipeline ingestion of a specified snapshot. + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/triggerSnapshotIngestion. diff --git a/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt b/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt index dd9c8d9d39..4e250517b7 100644 --- a/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt @@ -12,10 +12,12 @@ atlas api dataLakePipelines updatePipeline :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates one Data Lake Pipeline.Updates one Data Lake Pipeline. + 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. -Updates one Data Lake Pipeline. + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/updatePipeline. diff --git a/docs/command/atlas-api-dataLakePipelines.txt b/docs/command/atlas-api-dataLakePipelines.txt index 61aa7c873a..a34e92f9c0 100644 --- a/docs/command/atlas-api-dataLakePipelines.txt +++ b/docs/command/atlas-api-dataLakePipelines.txt @@ -12,10 +12,14 @@ atlas api dataLakePipelines :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs.Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. + 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. -Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. + + + Options ------- @@ -52,58 +56,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-dataLakePipelines-createPipeline` - 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. - -Creates one Data Lake Pipeline. -* :ref:`atlas-api-dataLakePipelines-deletePipeline` - 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. - -Removes one Data Lake Pipeline. -* :ref:`atlas-api-dataLakePipelines-deletePipelineRunDataset` - 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. - -Deletes dataset that Atlas generated during the specified pipeline run. -* :ref:`atlas-api-dataLakePipelines-getPipeline` - 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. - -Returns the details of one Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-getPipelineRun` - 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. - -Returns the details of one Data Lake Pipeline run within the specified project. -* :ref:`atlas-api-dataLakePipelines-listPipelineRuns` - 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. - -Returns a list of past Data Lake Pipeline runs. -* :ref:`atlas-api-dataLakePipelines-listPipelineSchedules` - 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. - -Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. -* :ref:`atlas-api-dataLakePipelines-listPipelineSnapshots` - 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. - -Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. -* :ref:`atlas-api-dataLakePipelines-listPipelines` - 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. - -Returns a list of Data Lake Pipelines. -* :ref:`atlas-api-dataLakePipelines-pausePipeline` - 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. - -Pauses ingestion for a Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-resumePipeline` - 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. - -Resumes ingestion for a Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-triggerSnapshotIngestion` - 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. - -Triggers a Data Lake Pipeline ingestion of a specified snapshot. -* :ref:`atlas-api-dataLakePipelines-updatePipeline` - 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. - -Updates one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-createPipeline` - `Public Preview: please provide feedback `_: Creates one Data Lake Pipeline.Creates one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-deletePipeline` - `Public Preview: please provide feedback `_: Removes one Data Lake Pipeline.Removes one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-deletePipelineRunDataset` - `Public Preview: please provide feedback `_: Deletes dataset that Atlas generated during the specified pipeline run.Deletes dataset that Atlas generated during the specified pipeline run. +* :ref:`atlas-api-dataLakePipelines-getPipeline` - `Public Preview: please provide feedback `_: Returns the details of one Data Lake Pipeline within the specified project.Returns the details of one Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-getPipelineRun` - `Public Preview: please provide feedback `_: Returns the details of one Data Lake Pipeline run within the specified project.Returns the details of one Data Lake Pipeline run within the specified project. +* :ref:`atlas-api-dataLakePipelines-listPipelineRuns` - `Public Preview: please provide feedback `_: Returns a list of past Data Lake Pipeline runs.Returns a list of past Data Lake Pipeline runs. +* :ref:`atlas-api-dataLakePipelines-listPipelineSchedules` - `Public Preview: please provide feedback `_: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source.Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. +* :ref:`atlas-api-dataLakePipelines-listPipelineSnapshots` - `Public Preview: please provide feedback `_: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run.Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. +* :ref:`atlas-api-dataLakePipelines-listPipelines` - `Public Preview: please provide feedback `_: Returns a list of Data Lake Pipelines.Returns a list of Data Lake Pipelines. +* :ref:`atlas-api-dataLakePipelines-pausePipeline` - `Public Preview: please provide feedback `_: Pauses ingestion for a Data Lake Pipeline within the specified project.Pauses ingestion for a Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-resumePipeline` - `Public Preview: please provide feedback `_: Resumes ingestion for a Data Lake Pipeline within the specified project.Resumes ingestion for a Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-triggerSnapshotIngestion` - `Public Preview: please provide feedback `_: Triggers a Data Lake Pipeline ingestion of a specified snapshot.Triggers a Data Lake Pipeline ingestion of a specified snapshot. +* :ref:`atlas-api-dataLakePipelines-updatePipeline` - `Public Preview: please provide feedback `_: Updates one Data Lake Pipeline.Updates one Data Lake Pipeline. .. toctree:: diff --git a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt index b3da053fb6..d6c59a504f 100644 --- a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt @@ -12,10 +12,12 @@ atlas api databaseUsers createDatabaseUser :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one database user in the specified project.Creates one database user in the specified project. + 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. -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 320da160e2..b9b08cf47e 100644 --- a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt @@ -12,10 +12,12 @@ atlas api databaseUsers deleteDatabaseUser :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one database user from the specified project.Removes one database user from the specified project. + 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. -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 11cb57e50e..ad1a1d13a1 100644 --- a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt @@ -12,10 +12,12 @@ atlas api databaseUsers getDatabaseUser :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one database user that belong to the specified project.Returns one database user that belong to the specified project. + 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. -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 cca58eaec5..7368040def 100644 --- a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt +++ b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt @@ -12,10 +12,12 @@ atlas api databaseUsers listDatabaseUsers :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all database users that belong to the specified project.Returns all database users that belong to the specified project. + 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. -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 52637c8840..3916feda89 100644 --- a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt @@ -12,10 +12,12 @@ atlas api databaseUsers updateDatabaseUser :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates one database user that belongs to the specified project.Updates one database user that belongs to the specified project. + 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. -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 e22e5955be..e8db626976 100644 --- a/docs/command/atlas-api-databaseUsers.txt +++ b/docs/command/atlas-api-databaseUsers.txt @@ -12,10 +12,14 @@ atlas api databaseUsers :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes database users.Returns, adds, edits, and removes database users. + 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. -Returns, adds, edits, and removes database users. + + + Options ------- @@ -52,26 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-databaseUsers-createDatabaseUser` - 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. - -Creates one database user in the specified project. -* :ref:`atlas-api-databaseUsers-deleteDatabaseUser` - 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. - -Removes one database user from the specified project. -* :ref:`atlas-api-databaseUsers-getDatabaseUser` - 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. - -Returns one database user that belong to the specified project. -* :ref:`atlas-api-databaseUsers-listDatabaseUsers` - 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. - -Returns all database users that belong to the specified project. -* :ref:`atlas-api-databaseUsers-updateDatabaseUser` - 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. - -Updates one database user that belongs to the specified project. +* :ref:`atlas-api-databaseUsers-createDatabaseUser` - `Public Preview: please provide feedback `_: Creates one database user in the specified project.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.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.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.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.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 48d2ba6989..43b949d21a 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt @@ -12,10 +12,12 @@ 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.Creates a private endpoint in the specified region for encryption at rest using customer key management. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/createEncryptionAtRestPrivateEndpoint. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt index 79584bdd71..4c8d6373c7 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt @@ -12,10 +12,12 @@ 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.Returns the configuration for encryption at rest using the keys you manage through your cloud provider. + 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. -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 40c4b9d0d8..f8a3b60ba4 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt @@ -12,10 +12,12 @@ 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.Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpoint. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt index dc785fcd92..855a98d4cb 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt @@ -12,10 +12,12 @@ 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.Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpointsForCloudProvider. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt index 0d21684152..7448ec2f6a 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt @@ -12,10 +12,12 @@ 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.Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/requestEncryptionAtRestPrivateEndpointDeletion. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt index 0858e65734..0706b37a7c 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt @@ -12,10 +12,12 @@ 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.Updates the configuration for encryption at rest using the keys you manage through your cloud provider. + 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. -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 370ca5ea60..d9398707b6 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt @@ -12,10 +12,12 @@ atlas api encryptionAtRestUsingCustomerKeyManagement :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns and edits the Encryption at Rest using Customer Key Management configuration.Returns and edits the Encryption at Rest using Customer Key Management configuration. + 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. -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,30 +56,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint` - 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. - -Creates a private endpoint in the specified region for encryption at rest using customer key management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest` - 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. - -Returns the configuration for encryption at rest using the keys you manage through your cloud provider. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint` - 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. - -Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider` - 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. - -Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion` - 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. - -Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest` - 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. - -Updates the configuration for encryption at rest using the keys you manage through your cloud provider. +* :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.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.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.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.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.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.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 17cd3d69e4..0f47c9d8ad 100644 --- a/docs/command/atlas-api-events-getOrganizationEvent.txt +++ b/docs/command/atlas-api-events-getOrganizationEvent.txt @@ -12,10 +12,12 @@ atlas api events getOrganizationEvent :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one event for the specified organization.Returns one event for the specified organization. + 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. -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 All 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 9206b42c9c..5f4af219ec 100644 --- a/docs/command/atlas-api-events-getProjectEvent.txt +++ b/docs/command/atlas-api-events-getProjectEvent.txt @@ -12,10 +12,12 @@ atlas api events getProjectEvent :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one event for the specified project.Returns one event for the specified project. + 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. -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 All 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 ea1213af13..b56230885f 100644 --- a/docs/command/atlas-api-events-listEventTypes.txt +++ b/docs/command/atlas-api-events-listEventTypes.txt @@ -12,10 +12,12 @@ 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.Returns a list of all event types, along with a description and additional metadata about each event. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listEventTypes. diff --git a/docs/command/atlas-api-events-listOrganizationEvents.txt b/docs/command/atlas-api-events-listOrganizationEvents.txt index d43e6eeabc..e86e542a6d 100644 --- a/docs/command/atlas-api-events-listOrganizationEvents.txt +++ b/docs/command/atlas-api-events-listOrganizationEvents.txt @@ -12,10 +12,12 @@ atlas api events listOrganizationEvents :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all events for the specified organization.Returns all events for the specified organization. + 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. -Returns all 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 f54a725426..e74a394ae2 100644 --- a/docs/command/atlas-api-events-listProjectEvents.txt +++ b/docs/command/atlas-api-events-listProjectEvents.txt @@ -12,10 +12,12 @@ atlas api events listProjectEvents :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all events for the specified project.Returns all events for the specified project. + 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. -Returns all 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 fbdebcea7c..a6c65eb74c 100644 --- a/docs/command/atlas-api-events.txt +++ b/docs/command/atlas-api-events.txt @@ -12,10 +12,12 @@ atlas api events :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns events.Returns events. + 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. -Returns events. + This collection remains under revision and may change. @@ -54,26 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-events-getOrganizationEvent` - 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. - -Returns one event for the specified organization. -* :ref:`atlas-api-events-getProjectEvent` - 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. - -Returns one event for the specified project. -* :ref:`atlas-api-events-listEventTypes` - 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. - -Returns a list of all event types, along with a description and additional metadata about each event. -* :ref:`atlas-api-events-listOrganizationEvents` - 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. - -Returns all events for the specified organization. -* :ref:`atlas-api-events-listProjectEvents` - 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. - -Returns all events for the specified project. +* :ref:`atlas-api-events-getOrganizationEvent` - `Public Preview: please provide feedback `_: Returns one event for the specified organization.Returns one event for the specified organization. +* :ref:`atlas-api-events-getProjectEvent` - `Public Preview: please provide feedback `_: Returns one event for the specified project.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.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 all events for the specified organization.Returns all events for the specified organization. +* :ref:`atlas-api-events-listProjectEvents` - `Public Preview: please provide feedback `_: Returns all events for the specified project.Returns all 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 ebdc465347..998878d6ae 100644 --- a/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt @@ -12,10 +12,12 @@ atlas api federatedAuthentication createIdentityProvider :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one identity provider within the specified federation.Creates one identity provider within the specified federation. + 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. -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 5d56d0e7d4..892c2db955 100644 --- a/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt @@ -12,10 +12,12 @@ 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.Adds one role mapping to the specified organization in the specified federation. + 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. -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 8609ecacc1..9220eb8b6f 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt @@ -12,10 +12,12 @@ 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.Deletes the federation settings instance and all associated data, including identity providers and domains. + 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. -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 79a3840b19..b49bce075d 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt @@ -12,10 +12,12 @@ atlas api federatedAuthentication deleteIdentityProvider :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Deletes one identity provider in the specified federation.Deletes one identity provider in the specified federation. + 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. -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 87adb04769..e7be1a1df1 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt @@ -12,10 +12,12 @@ 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.Removes one role mapping in the specified organization from the specified federation. + 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. -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 b2450838b7..e13f72d701 100644 --- a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt @@ -12,10 +12,12 @@ atlas api federatedAuthentication getConnectedOrgConfig :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the specified connected org config from the specified federation.Returns the specified connected org config from the specified federation. + 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. -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 814561b7f3..259eaba023 100644 --- a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt +++ b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt @@ -12,10 +12,12 @@ atlas api federatedAuthentication getFederationSettings :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns information about the federation settings for the specified organization.Returns information about the federation settings for the specified organization. + 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. -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 598cb58b2a..a5e3c55e98 100644 --- a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt @@ -12,10 +12,12 @@ 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.Returns one identity provider in the specified federation by the identity provider's id. + 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. -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 7fecec2872..f9765b2b6c 100644 --- a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt +++ b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt @@ -12,10 +12,12 @@ atlas api federatedAuthentication getIdentityProviderMetadata :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the metadata of one identity provider in the specified federation.Returns the metadata of one identity provider in the specified federation. + 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. -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 3cd07de431..d11bfa0b42 100644 --- a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt @@ -12,10 +12,12 @@ 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.Returns one role mapping from the specified organization in the specified federation. + 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. -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 a4f44e405c..de7c0d3e53 100644 --- a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt +++ b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt @@ -12,10 +12,12 @@ atlas api federatedAuthentication listConnectedOrgConfigs :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all connected org configs in the specified federation.Returns all connected org configs in the specified federation. + 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. -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 b3fceed71b..b59ddd5cc9 100644 --- a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt +++ b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt @@ -12,10 +12,12 @@ 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.Returns all identity providers with the provided protocol and type in the specified federation. + 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. -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 2ce3439c6d..d70e0d2174 100644 --- a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt +++ b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt @@ -12,10 +12,12 @@ 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.Returns all role mappings from the specified organization in the specified federation. + 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. -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 bea878eaa2..42d6492f61 100644 --- a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt @@ -12,10 +12,12 @@ atlas api federatedAuthentication removeConnectedOrgConfig :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one connected organization configuration from the specified federation.Removes one connected organization configuration from the specified federation. + 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. -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 1d97de6718..c7a6b55ffa 100644 --- a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt @@ -12,10 +12,12 @@ atlas api federatedAuthentication revokeJwksFromIdentityProvider :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Revokes the JWKS tokens from the requested OIDC identity provider.Revokes the JWKS tokens from the requested OIDC identity provider. + 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. -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 9bdfd05065..74bb76c4c7 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt @@ -12,10 +12,12 @@ atlas api federatedAuthentication updateConnectedOrgConfig :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates one connected organization configuration from the specified federation.Updates one connected organization configuration from the specified federation. + 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. -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 b641dcbd18..0c5bc4aabb 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt @@ -12,10 +12,12 @@ atlas api federatedAuthentication updateIdentityProvider :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates one identity provider in the specified federation.Updates one identity provider in the specified federation. + 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. -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 917af48438..6cbfe36035 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt @@ -12,10 +12,12 @@ 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.Updates one role mapping in the specified organization in the specified federation. + 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. -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 1690855798..995c2ba558 100644 --- a/docs/command/atlas-api-federatedAuthentication.txt +++ b/docs/command/atlas-api-federatedAuthentication.txt @@ -12,10 +12,14 @@ 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.Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. + 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. -Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. + + + Options ------- @@ -52,78 +56,24 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-federatedAuthentication-createIdentityProvider` - 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. - -Creates one identity provider within the specified federation. -* :ref:`atlas-api-federatedAuthentication-createRoleMapping` - 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. - -Adds one role mapping to the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-deleteFederationApp` - 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. - -Deletes the federation settings instance and all associated data, including identity providers and domains. -* :ref:`atlas-api-federatedAuthentication-deleteIdentityProvider` - 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. - -Deletes one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-deleteRoleMapping` - 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. - -Removes one role mapping in the specified organization from the specified federation. -* :ref:`atlas-api-federatedAuthentication-getConnectedOrgConfig` - 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. - -Returns the specified connected org config from the specified federation. -* :ref:`atlas-api-federatedAuthentication-getFederationSettings` - 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. - -Returns information about the federation settings for the specified organization. -* :ref:`atlas-api-federatedAuthentication-getIdentityProvider` - 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. - -Returns one identity provider in the specified federation by the identity provider's id. -* :ref:`atlas-api-federatedAuthentication-getIdentityProviderMetadata` - 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. - -Returns the metadata of one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-getRoleMapping` - 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. - -Returns one role mapping from the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listConnectedOrgConfigs` - 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. - -Returns all connected org configs in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listIdentityProviders` - 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. - -Returns all identity providers with the provided protocol and type in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listRoleMappings` - 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. - -Returns all role mappings from the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-removeConnectedOrgConfig` - 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. - -Removes one connected organization configuration from the specified federation. -* :ref:`atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider` - 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. - -Revokes the JWKS tokens from the requested OIDC identity provider. -* :ref:`atlas-api-federatedAuthentication-updateConnectedOrgConfig` - 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. - -Updates one connected organization configuration from the specified federation. -* :ref:`atlas-api-federatedAuthentication-updateIdentityProvider` - 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. - -Updates one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-updateRoleMapping` - 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. - -Updates one role mapping in the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-createIdentityProvider` - `Public Preview: please provide feedback `_: Creates one identity provider within the specified federation.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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 6260f99391..dbcb5e6057 100644 --- a/docs/command/atlas-api-flexClusters-createFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-createFlexCluster.txt @@ -12,10 +12,12 @@ atlas api flexClusters createFlexCluster :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one flex cluster in the specified project.Creates one flex cluster in the specified project. + 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. -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 1287ccf74e..5cc682265d 100644 --- a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt @@ -12,10 +12,12 @@ atlas api flexClusters deleteFlexCluster :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one flex cluster from the specified project.Removes one flex cluster from the specified project. + 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. -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 c21e3e6b19..39bfde1903 100644 --- a/docs/command/atlas-api-flexClusters-getFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-getFlexCluster.txt @@ -12,10 +12,12 @@ atlas api flexClusters getFlexCluster :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns details for one flex cluster in the specified project.Returns details for one flex cluster in the specified project. + 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. -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 c97d5ca825..3daf0951b9 100644 --- a/docs/command/atlas-api-flexClusters-listFlexClusters.txt +++ b/docs/command/atlas-api-flexClusters-listFlexClusters.txt @@ -12,10 +12,12 @@ atlas api flexClusters listFlexClusters :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns details for all flex clusters in the specified project.Returns details for all flex clusters in the specified project. + 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. -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 209ddeeca3..1311aac18a 100644 --- a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt @@ -12,10 +12,12 @@ atlas api flexClusters updateFlexCluster :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates one flex cluster in the specified project.Updates one flex cluster in the specified project. + 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. -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 2bbf88b3e1..269f829e90 100644 --- a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt @@ -12,10 +12,12 @@ 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.Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. + 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. -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 9b86bc9d24..d16b525313 100644 --- a/docs/command/atlas-api-flexClusters.txt +++ b/docs/command/atlas-api-flexClusters.txt @@ -12,10 +12,14 @@ atlas api flexClusters :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes flex clusters.Returns, adds, edits, and removes flex clusters. + 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. -Returns, adds, edits, and removes flex clusters. + + + Options ------- @@ -52,30 +56,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexClusters-createFlexCluster` - 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. - -Creates one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-deleteFlexCluster` - 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. - -Removes one flex cluster from the specified project. -* :ref:`atlas-api-flexClusters-getFlexCluster` - 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. - -Returns details for one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-listFlexClusters` - 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. - -Returns details for all flex clusters in the specified project. -* :ref:`atlas-api-flexClusters-updateFlexCluster` - 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. - -Updates one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-upgradeFlexCluster` - 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. - -Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. +* :ref:`atlas-api-flexClusters-createFlexCluster` - `Public Preview: please provide feedback `_: Creates one flex cluster in the specified project.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.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.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.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.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.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 dc516fb2ef..1b8bdfa00b 100644 --- a/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt +++ b/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt @@ -12,10 +12,12 @@ atlas api flexRestoreJobs createFlexBackupRestoreJob :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Restores one snapshot of one flex cluster from the specified project.Restores one snapshot of one flex cluster from the specified project. + 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. -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 87121f1cc2..8f58aecd08 100644 --- a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt +++ b/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt @@ -12,10 +12,12 @@ 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.Returns one restore job for one flex cluster from the specified project. + 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. -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 45f032f2e6..746e7977de 100644 --- a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt +++ b/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt @@ -12,10 +12,12 @@ 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.Returns all restore jobs for one flex cluster from the specified project. + 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. -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 52546e47fe..27655277bd 100644 --- a/docs/command/atlas-api-flexRestoreJobs.txt +++ b/docs/command/atlas-api-flexRestoreJobs.txt @@ -12,10 +12,14 @@ atlas api flexRestoreJobs :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns and adds restore jobs for flex database deployments.Returns and adds restore jobs for flex database deployments. + 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. -Returns and adds restore jobs for flex database deployments. + + + Options ------- @@ -52,18 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexRestoreJobs-createFlexBackupRestoreJob` - 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. - -Restores one snapshot of one flex cluster from the specified project. -* :ref:`atlas-api-flexRestoreJobs-getFlexBackupRestoreJob` - 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. - -Returns one restore job for one flex cluster from the specified project. -* :ref:`atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs` - 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. - -Returns all restore jobs for one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-createFlexBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores one snapshot of one flex cluster from the specified project.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.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.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 1dbd89c7f7..bdc54ecbb6 100644 --- a/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt +++ b/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt @@ -12,10 +12,12 @@ atlas api flexSnapshots downloadFlexBackup :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Requests one snapshot for the specified flex cluster.Requests one snapshot for the specified flex cluster. + 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. -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 0fce888cba..ae7dcb72cc 100644 --- a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt +++ b/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt @@ -12,10 +12,12 @@ atlas api flexSnapshots getFlexBackup :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one snapshot of one flex cluster from the specified project.Returns one snapshot of one flex cluster from the specified project. + 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. -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 a8469347b7..5914933355 100644 --- a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt +++ b/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt @@ -12,10 +12,12 @@ atlas api flexSnapshots listFlexBackups :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all snapshots of one flex cluster from the specified project.Returns all snapshots of one flex cluster from the specified project. + 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. -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 06b0187fb2..261b6f7fea 100644 --- a/docs/command/atlas-api-flexSnapshots.txt +++ b/docs/command/atlas-api-flexSnapshots.txt @@ -12,10 +12,14 @@ atlas api flexSnapshots :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns and requests to download flex database deployment snapshots.Returns and requests to download flex database deployment snapshots. + 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. -Returns and requests to download flex database deployment snapshots. + + + Options ------- @@ -52,18 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexSnapshots-downloadFlexBackup` - 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. - -Requests one snapshot for the specified flex cluster. -* :ref:`atlas-api-flexSnapshots-getFlexBackup` - 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. - -Returns one snapshot of one flex cluster from the specified project. -* :ref:`atlas-api-flexSnapshots-listFlexBackups` - 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. - -Returns all snapshots of one flex cluster from the specified project. +* :ref:`atlas-api-flexSnapshots-downloadFlexBackup` - `Public Preview: please provide feedback `_: Requests one snapshot for the specified flex cluster.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.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.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 11148498f8..abb740dbeb 100644 --- a/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt +++ b/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt @@ -12,10 +12,12 @@ atlas api globalClusters createCustomZoneMapping :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one custom zone mapping for the specified global cluster.Creates one custom zone mapping for the specified global cluster. + 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. -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 4281e78d2c..86429836a8 100644 --- a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt @@ -12,10 +12,12 @@ atlas api globalClusters createManagedNamespace :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one managed namespace within the specified global cluster.Creates one managed namespace within the specified global cluster. + 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. -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 9c7cbe18cd..cb9b5efecf 100644 --- a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt +++ b/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt @@ -12,10 +12,12 @@ atlas api globalClusters deleteAllCustomZoneMappings :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes all custom zone mappings for the specified global cluster.Removes all custom zone mappings for the specified global cluster. + 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. -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 4f9625dfc6..b552438c83 100644 --- a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt @@ -12,10 +12,12 @@ atlas api globalClusters deleteManagedNamespace :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one managed namespace within the specified global cluster.Removes one managed namespace within the specified global cluster. + 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. -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 d30c5bed83..633ac8d16d 100644 --- a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-getManagedNamespace.txt @@ -12,10 +12,12 @@ atlas api globalClusters getManagedNamespace :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one managed namespace within the specified global cluster.Returns one managed namespace within the specified global cluster. + 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. -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 4ea2722e0f..3a3f4f5b24 100644 --- a/docs/command/atlas-api-globalClusters.txt +++ b/docs/command/atlas-api-globalClusters.txt @@ -12,10 +12,12 @@ atlas api globalClusters :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings.Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. + 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. -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,26 +57,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-globalClusters-createCustomZoneMapping` - 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. - -Creates one custom zone mapping for the specified global cluster. -* :ref:`atlas-api-globalClusters-createManagedNamespace` - 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. - -Creates one managed namespace within the specified global cluster. -* :ref:`atlas-api-globalClusters-deleteAllCustomZoneMappings` - 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. - -Removes all custom zone mappings for the specified global cluster. -* :ref:`atlas-api-globalClusters-deleteManagedNamespace` - 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. - -Removes one managed namespace within the specified global cluster. -* :ref:`atlas-api-globalClusters-getManagedNamespace` - 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. - -Returns one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-createCustomZoneMapping` - `Public Preview: please provide feedback `_: Creates one custom zone mapping for the specified global cluster.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.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.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.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.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 d94910cda9..9c65d1b010 100644 --- a/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt +++ b/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt @@ -12,10 +12,12 @@ 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.Creates a query process within the Cost Explorer for the given parameters. + 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. -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 a840640ed1..522023be57 100644 --- a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt +++ b/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt @@ -12,10 +12,12 @@ 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.Returns one invoice that MongoDB issued to the specified organization in CSV format. + 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. -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 2dd16fab54..d2b2e71db4 100644 --- a/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt +++ b/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt @@ -12,10 +12,12 @@ 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.Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. + 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. -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 442d2dbead..84e040e47d 100644 --- a/docs/command/atlas-api-invoices-getInvoice.txt +++ b/docs/command/atlas-api-invoices-getInvoice.txt @@ -12,10 +12,12 @@ atlas api invoices getInvoice :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one invoice that MongoDB issued to the specified organization.Returns one invoice that MongoDB issued to the specified organization. + 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. -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 60a393b261..c0fbccb1d4 100644 --- a/docs/command/atlas-api-invoices-listInvoices.txt +++ b/docs/command/atlas-api-invoices-listInvoices.txt @@ -12,10 +12,12 @@ atlas api invoices listInvoices :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all invoices that MongoDB issued to the specified organization.Returns all invoices that MongoDB issued to the specified organization. + 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. -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 615975d391..ac35c306b8 100644 --- a/docs/command/atlas-api-invoices-listPendingInvoices.txt +++ b/docs/command/atlas-api-invoices-listPendingInvoices.txt @@ -12,10 +12,12 @@ 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.Returns all invoices accruing charges for the current billing cycle for the specified organization. + 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. -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 6a11ab65c9..5569b7baf8 100644 --- a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt +++ b/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt @@ -12,10 +12,12 @@ 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.Query the lineItems of the specified invoice and return the result JSON. + 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. -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 576dae9d70..69a6b04e5c 100644 --- a/docs/command/atlas-api-invoices.txt +++ b/docs/command/atlas-api-invoices.txt @@ -12,10 +12,14 @@ atlas api invoices :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns invoices.Returns invoices. + 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. -Returns invoices. + + + Options ------- @@ -52,34 +56,13 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-invoices-createCostExplorerQueryProcess` - 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. - -Creates a query process within the Cost Explorer for the given parameters. -* :ref:`atlas-api-invoices-downloadInvoiceCsv` - 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. - -Returns one invoice that MongoDB issued to the specified organization in CSV format. -* :ref:`atlas-api-invoices-getCostExplorerQueryProcess` - 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. - -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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. -* :ref:`atlas-api-invoices-listInvoices` - 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. - -Returns all invoices that MongoDB issued to the specified organization. -* :ref:`atlas-api-invoices-listPendingInvoices` - 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. - -Returns all invoices accruing charges for the current billing cycle for the specified organization. -* :ref:`atlas-api-invoices-queryLineItemsFromSingleInvoice` - 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. - -Query the lineItems of the specified invoice and return the result JSON. +* :ref:`atlas-api-invoices-createCostExplorerQueryProcess` - `Public Preview: please provide feedback `_: Creates a query process within the Cost Explorer for the given parameters.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.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.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.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.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.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.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 bd8d8a3857..3ee5d16f42 100644 --- a/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt @@ -12,10 +12,12 @@ 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.Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. + 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. -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 1a9d5d0d32..befd3b7346 100644 --- a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt @@ -12,10 +12,12 @@ atlas api ldapConfiguration getLdapConfiguration :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the current LDAP configuration for the specified project.Returns the current LDAP configuration for the specified project. + 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. -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 d6d8a8872a..704746bc24 100644 --- a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt +++ b/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt @@ -12,10 +12,12 @@ 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.Returns the status of one request to verify one LDAP configuration for the specified project. + 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. -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 330e0591e9..aa5ded52bb 100644 --- a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt @@ -12,10 +12,12 @@ atlas api ldapConfiguration saveLdapConfiguration :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Edits the LDAP configuration for the specified project.Edits the LDAP configuration for the specified project. + 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. -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 31969cd6bf..d474467831 100644 --- a/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt @@ -12,10 +12,12 @@ atlas api ldapConfiguration verifyLdapConfiguration :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Verifies the LDAP configuration for the specified project.Verifies the LDAP configuration for the specified project. + 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. -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 734f4cf87e..c43cddae3e 100644 --- a/docs/command/atlas-api-ldapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration.txt @@ -12,10 +12,12 @@ atlas api ldapConfiguration :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, edits, verifies, and removes LDAP configurations.Returns, edits, verifies, and removes LDAP configurations. + 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. -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,26 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-ldapConfiguration-deleteLdapConfiguration` - 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. - -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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. -* :ref:`atlas-api-ldapConfiguration-getLdapConfigurationStatus` - 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. - -Returns the status of one request to verify one LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-saveLdapConfiguration` - 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. - -Edits the LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-verifyLdapConfiguration` - 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. - -Verifies the LDAP configuration for the specified project. +* :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.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.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.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.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.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 9a2d18a434..43ef4db7fc 100644 --- a/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt +++ b/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt @@ -12,10 +12,12 @@ atlas api legacyBackup createLegacyBackupRestoreJob :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Restores one legacy backup for one cluster in the specified project.Restores one legacy backup for one cluster in the specified project. + 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. -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 43eb819fe9..eaca4f2afc 100644 --- a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt +++ b/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt @@ -12,10 +12,12 @@ 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.Removes one legacy backup snapshot for one cluster in the specified project. + 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. -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 0029b5e62d..55ec97aae5 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt @@ -12,10 +12,12 @@ 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.Returns one legacy backup checkpoint for one cluster in the specified project. + 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. -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 a5fffe6752..b1ba6a7959 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt @@ -12,10 +12,12 @@ 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.Returns one legacy backup restore job for one cluster in the specified project. + 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. -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 88eb8090ea..f5b2ded3f1 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt @@ -12,10 +12,12 @@ 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.Returns one legacy backup snapshot for one cluster in the specified project. + 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. -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 0c20e097da..c4b7447b5c 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt @@ -12,10 +12,12 @@ atlas api legacyBackup getLegacySnapshotSchedule :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the snapshot schedule for one cluster in the specified project.Returns the snapshot schedule for one cluster in the specified project. + 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. -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 841ed36403..36d9717e71 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt @@ -12,10 +12,12 @@ 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.Returns all legacy backup checkpoints for one cluster in the specified project. + 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. -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 25d708c314..bf40f5ba53 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt @@ -12,10 +12,12 @@ 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.Returns all legacy backup restore jobs for one cluster in the specified project. + 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. -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 3ca3951db6..f16ce9f361 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt @@ -12,10 +12,12 @@ 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.Returns all legacy backup snapshots for one cluster in the specified project. + 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. -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 185aed99ef..7049f045b3 100644 --- a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt +++ b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt @@ -12,10 +12,12 @@ 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.Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. + 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. -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 65f1e67656..f86e751be5 100644 --- a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt +++ b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt @@ -12,10 +12,12 @@ atlas api legacyBackup updateLegacySnapshotSchedule :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates the snapshot schedule for one cluster in the specified project.Updates the snapshot schedule for one cluster in the specified project. + 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. -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 78253edd48..cb8bce3fe6 100644 --- a/docs/command/atlas-api-legacyBackup.txt +++ b/docs/command/atlas-api-legacyBackup.txt @@ -12,10 +12,14 @@ atlas api legacyBackup :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints.Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. + 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. -Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. + + + Options ------- @@ -52,50 +56,17 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-legacyBackup-createLegacyBackupRestoreJob` - 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. - -Restores one legacy backup for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-deleteLegacySnapshot` - 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. - -Removes one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacyBackupCheckpoint` - 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. - -Returns one legacy backup checkpoint for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacyBackupRestoreJob` - 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. - -Returns one legacy backup restore job for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacySnapshot` - 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. - -Returns one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacySnapshotSchedule` - 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. - -Returns the snapshot schedule for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacyBackupCheckpoints` - 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. - -Returns all legacy backup checkpoints for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacyBackupRestoreJobs` - 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. - -Returns all legacy backup restore jobs for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacySnapshots` - 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. - -Returns all legacy backup snapshots for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-updateLegacySnapshotRetention` - 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. - -Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-updateLegacySnapshotSchedule` - 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. - -Updates the snapshot schedule for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-createLegacyBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores one legacy backup for one cluster in the specified project.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.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.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.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.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.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.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.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.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.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.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 0aad9d25f6..6f623fa78e 100644 --- a/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt @@ -12,10 +12,12 @@ atlas api maintenanceWindows deferMaintenanceWindow :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Defers the maintenance window for the specified project.Defers the maintenance window for the specified project. + 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. -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 aa29e38438..8e60aa9a4c 100644 --- a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt @@ -12,10 +12,12 @@ atlas api maintenanceWindows getMaintenanceWindow :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the maintenance window for the specified project.Returns the maintenance window for the specified project. + 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. -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 7947c60b7a..e1da3cb670 100644 --- a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt @@ -12,10 +12,12 @@ atlas api maintenanceWindows resetMaintenanceWindow :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Resets the maintenance window for the specified project.Resets the maintenance window for the specified project. + 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. -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 b72426c075..3e16734825 100644 --- a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt +++ b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt @@ -12,10 +12,12 @@ atlas api maintenanceWindows toggleMaintenanceAutoDefer :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Toggles automatic deferral of the maintenance window for the specified project.Toggles automatic deferral of the maintenance window for the specified project. + 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. -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 a5db2a25cb..1c6217ad0f 100644 --- a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt @@ -12,10 +12,12 @@ atlas api maintenanceWindows updateMaintenanceWindow :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates the maintenance window for the specified project.Updates the maintenance window for the specified project. + 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. -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 739f5be107..1f20cf0fde 100644 --- a/docs/command/atlas-api-maintenanceWindows.txt +++ b/docs/command/atlas-api-maintenanceWindows.txt @@ -12,10 +12,12 @@ atlas api maintenanceWindows :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, edits, and removes maintenance windows.Returns, edits, and removes maintenance windows. + 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. -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,26 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-maintenanceWindows-deferMaintenanceWindow` - 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. - -Defers the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-getMaintenanceWindow` - 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. - -Returns the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-resetMaintenanceWindow` - 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. - -Resets the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer` - 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. - -Toggles automatic deferral of the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-updateMaintenanceWindow` - 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. - -Updates the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-deferMaintenanceWindow` - `Public Preview: please provide feedback `_: Defers the maintenance window for the specified project.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.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.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.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.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 bd438c707f..1bf90b8387 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt @@ -12,10 +12,12 @@ atlas api mongoDbCloudUsers addOrganizationRole :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Adds one organization-level role to the MongoDB Cloud user.Adds one organization-level role to the MongoDB Cloud user. + 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. -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 e26109ba9d..212843dd57 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt @@ -12,10 +12,12 @@ atlas api mongoDbCloudUsers addProjectRole :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Adds one project-level role to the MongoDB Cloud user.Adds one project-level role to the MongoDB Cloud user. + 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. -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 e5a1de48ea..c6d6904f31 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt @@ -12,10 +12,12 @@ atlas api mongoDbCloudUsers addProjectUser :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to one project.Adds one MongoDB Cloud user to one project. + 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. -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 b958c4609e..afb1e86c69 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt @@ -12,10 +12,12 @@ atlas api mongoDbCloudUsers addUserToTeam :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to one team.Adds one MongoDB Cloud user to one team. + 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. -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 303600b953..67789ea68b 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt @@ -12,10 +12,12 @@ 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.Invites one new or existing MongoDB Cloud user to join the organization. + 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. -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 5615dcc694..a95f161da2 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt @@ -12,10 +12,12 @@ atlas api mongoDbCloudUsers createUser :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one MongoDB Cloud user account.Creates one MongoDB Cloud user account. + 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. -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 fdf3ff2324..df393ceae7 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt @@ -12,10 +12,12 @@ 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.Returns information about the specified MongoDB Cloud user within the context of the specified organization. + 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. -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 400b6515c1..0013c075c7 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt @@ -12,10 +12,12 @@ 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.Returns information about the specified MongoDB Cloud user within the context of the specified project. + 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. -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 cc706d3caf..e570a549af 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt @@ -12,10 +12,12 @@ 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.Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. + 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. -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 1217621ce2..b07c9eb1a4 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt @@ -12,10 +12,12 @@ 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.Returns the details for one MongoDB Cloud user account with the specified username. + 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. -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 b1400eb6eb..dbeffeb8ba 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt @@ -12,10 +12,12 @@ 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.Returns details about the pending and active MongoDB Cloud users associated with the specified organization. + 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. -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 f2a91603df..09ec982c0f 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt @@ -12,10 +12,12 @@ 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.Returns details about the pending and active MongoDB Cloud users associated with the specified project. + 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. -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 3b764f2c83..64f2912f54 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt @@ -12,10 +12,12 @@ 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.Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. + 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. -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 dc6e5fdd17..b41cb5cf40 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt @@ -12,10 +12,12 @@ atlas api mongoDbCloudUsers removeOrganizationRole :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one organization-level role from the MongoDB Cloud user.Removes one organization-level role from the MongoDB Cloud user. + 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. -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 8303b59180..97ab00eb16 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt @@ -12,10 +12,12 @@ atlas api mongoDbCloudUsers removeOrganizationUser :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user in the specified organization.Removes one MongoDB Cloud user in the specified organization. + 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. -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 9fc66357cf..8a5eec441d 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt @@ -12,10 +12,12 @@ atlas api mongoDbCloudUsers removeProjectRole :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one project-level role from the MongoDB Cloud user.Removes one project-level role from the MongoDB Cloud user. + 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. -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 e6f362ac27..b16cdc6c89 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt @@ -12,10 +12,12 @@ atlas api mongoDbCloudUsers removeProjectUser :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from the specified project.Removes one MongoDB Cloud user from the specified project. + 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. -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 9a23519417..54778d086f 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt @@ -12,10 +12,12 @@ atlas api mongoDbCloudUsers removeUserFromTeam :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from one team.Removes one MongoDB Cloud user from one team. + 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. -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 4372df8578..d9db29a8a1 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt @@ -12,10 +12,12 @@ atlas api mongoDbCloudUsers updateOrganizationUser :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates one MongoDB Cloud user in the specified organization.Updates one MongoDB Cloud user in the specified organization. + 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. -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 979b38cf0e..0e029bc5ea 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers.txt @@ -12,10 +12,14 @@ atlas api mongoDbCloudUsers :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, and edits MongoDB Cloud users.Returns, adds, and edits MongoDB Cloud users. + 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. -Returns, adds, and edits MongoDB Cloud users. + + + Options ------- @@ -52,82 +56,25 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-mongoDbCloudUsers-addOrganizationRole` - 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. - -Adds one organization-level role to the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-addProjectRole` - 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. - -Adds one project-level role to the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-addProjectUser` - 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. - -Adds one MongoDB Cloud user to one project. -* :ref:`atlas-api-mongoDbCloudUsers-addUserToTeam` - 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. - -Adds one MongoDB Cloud user to one team. -* :ref:`atlas-api-mongoDbCloudUsers-createOrganizationUser` - 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. - -Invites one new or existing MongoDB Cloud user to join the organization. -* :ref:`atlas-api-mongoDbCloudUsers-createUser` - 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. - -Creates one MongoDB Cloud user account. -* :ref:`atlas-api-mongoDbCloudUsers-getOrganizationUser` - 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. - -Returns information about the specified MongoDB Cloud user within the context of the specified organization. -* :ref:`atlas-api-mongoDbCloudUsers-getProjectUser` - 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. - -Returns information about the specified MongoDB Cloud user within the context of the specified project. -* :ref:`atlas-api-mongoDbCloudUsers-getUser` - 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. - -Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. -* :ref:`atlas-api-mongoDbCloudUsers-getUserByUsername` - 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. - -Returns the details for one MongoDB Cloud user account with the specified username. -* :ref:`atlas-api-mongoDbCloudUsers-listOrganizationUsers` - 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. - -Returns details about the pending and active MongoDB Cloud users associated with the specified organization. -* :ref:`atlas-api-mongoDbCloudUsers-listProjectUsers` - 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. - -Returns details about the pending and active MongoDB Cloud users associated with the specified project. -* :ref:`atlas-api-mongoDbCloudUsers-listTeamUsers` - 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. - -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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. -* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationUser` - 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. - -Removes one MongoDB Cloud user in the specified organization. -* :ref:`atlas-api-mongoDbCloudUsers-removeProjectRole` - 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. - -Removes one project-level role from the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-removeProjectUser` - 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. - -Removes one MongoDB Cloud user from the specified project. -* :ref:`atlas-api-mongoDbCloudUsers-removeUserFromTeam` - 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. - -Removes one MongoDB Cloud user from one team. -* :ref:`atlas-api-mongoDbCloudUsers-updateOrganizationUser` - 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. - -Updates one MongoDB Cloud user in the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-addOrganizationRole` - `Public Preview: please provide feedback `_: Adds one organization-level role to the MongoDB Cloud user.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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 2f227ab705..24c9643802 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt @@ -12,10 +12,12 @@ atlas api monitoringAndLogs getAtlasProcess :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the processes for the specified host for the specified project.Returns the processes for the specified host for the specified project. + 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. -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 2dd0c280a3..2e4307549b 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt @@ -12,10 +12,12 @@ 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.Returns one database running on the specified host for the specified project. + 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. -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 547396fcf2..954f023c07 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt @@ -12,10 +12,12 @@ 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.Returns the measurements of one database for the specified host for the specified project. + 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. -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 f5f95c5110..1d7cdee5ee 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt @@ -12,10 +12,12 @@ 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.Returns the measurements of one disk or partition for the specified host for the specified project. + 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. -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 0780036452..371f72e6d4 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt @@ -12,10 +12,12 @@ 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.Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. + 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. -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 a279c489ad..23cb259b59 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt @@ -12,10 +12,12 @@ 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.Returns disk, partition, or host measurements per process for the specified host for the specified project. + 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. -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 88dbc5a318..ad452a1b56 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt @@ -12,10 +12,12 @@ 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.Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. + 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. -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 72d2650dff..864890c179 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt @@ -12,10 +12,12 @@ 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.Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. + 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. -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 6f30ae2de1..bf9c0899bf 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt @@ -12,10 +12,12 @@ atlas api monitoringAndLogs listAtlasProcesses :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns details of all processes for the specified project.Returns details of all processes for the specified project. + 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. -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 1b453d626a..78c3232c21 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt @@ -12,10 +12,12 @@ 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.Returns the list of databases running on the specified host for the specified project. + 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. -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 a5685c25fe..c5bb80d285 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt @@ -12,10 +12,12 @@ 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.Returns measurement details for one disk or partition for the specified host for the specified project. + 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. -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 3367229401..cb6f8239b8 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt @@ -12,10 +12,12 @@ 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.Returns the list of disks or partitions for the specified host for the specified project. + 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. -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 5dabb6e29e..034dab2799 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt @@ -12,10 +12,12 @@ 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.Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listIndexMetrics. diff --git a/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt b/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt index 0812666e25..e41f572b1b 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt @@ -12,10 +12,12 @@ 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.Returns all Atlas Search metric types available for one process in the specified project. + 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. -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 28d77fb594..37bc4d789b 100644 --- a/docs/command/atlas-api-monitoringAndLogs.txt +++ b/docs/command/atlas-api-monitoringAndLogs.txt @@ -12,10 +12,14 @@ atlas api monitoringAndLogs :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns database deployment monitoring and logging data.Returns database deployment monitoring and logging data. + 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. -Returns database deployment monitoring and logging data. + + + Options ------- @@ -52,62 +56,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-monitoringAndLogs-getAtlasProcess` - 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. - -Returns the processes for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDatabase` - 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. - -Returns one database running on the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDatabaseMeasurements` - 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. - -Returns the measurements of one database for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDiskMeasurements` - 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. - -Returns the measurements of one disk or partition for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getHostLogs` - 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. - -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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. -* :ref:`atlas-api-monitoringAndLogs-getIndexMetrics` - 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. - -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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. -* :ref:`atlas-api-monitoringAndLogs-listAtlasProcesses` - 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. - -Returns details of all processes for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDatabases` - 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. - -Returns the list of databases running on the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDiskMeasurements` - 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. - -Returns measurement details for one disk or partition for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDiskPartitions` - 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. - -Returns the list of disks or partitions for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listIndexMetrics` - 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. - -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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +* :ref:`atlas-api-monitoringAndLogs-getAtlasProcess` - `Public Preview: please provide feedback `_: Returns the processes for the specified host for the specified project.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.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.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.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.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.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.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.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.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.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.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.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.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.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 bc9fa37014..f2b4cefeb2 100644 --- a/docs/command/atlas-api-networkPeering-createPeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-createPeeringConnection.txt @@ -12,10 +12,12 @@ atlas api networkPeering createPeeringConnection :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one new network peering connection in the specified project.Creates one new network peering connection in the specified project. + 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. -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 e9f825d485..68c2b5b05b 100644 --- a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-createPeeringContainer.txt @@ -12,10 +12,12 @@ atlas api networkPeering createPeeringContainer :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one new network peering container in the specified project.Creates one new network peering container in the specified project. + 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. -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 6f404a1d64..adf4343da7 100644 --- a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt @@ -12,10 +12,12 @@ atlas api networkPeering deletePeeringConnection :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one network peering connection in the specified project.Removes one network peering connection in the specified project. + 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. -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 a1e880a4dd..586cdf30df 100644 --- a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt @@ -12,10 +12,12 @@ atlas api networkPeering deletePeeringContainer :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one network peering container in the specified project.Removes one network peering container in the specified project. + 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. -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 76c1203de9..a23b82ef2a 100644 --- a/docs/command/atlas-api-networkPeering-disablePeering.txt +++ b/docs/command/atlas-api-networkPeering-disablePeering.txt @@ -12,10 +12,12 @@ atlas api networkPeering disablePeering :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Disables Connect via Peering Only mode for the specified project.Disables Connect via Peering Only mode for the specified project. + 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. -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 5fd19724d8..588baaa2b3 100644 --- a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-getPeeringConnection.txt @@ -12,10 +12,12 @@ 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.Returns details about one specified network peering connection in the specified project. + 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. -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 4003724e82..438de6ade8 100644 --- a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-getPeeringContainer.txt @@ -12,10 +12,12 @@ atlas api networkPeering getPeeringContainer :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns details about one network peering container in one specified project.Returns details about one network peering container in one specified project. + 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. -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 3cb596b050..af068d3a46 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringConnections.txt @@ -12,10 +12,12 @@ atlas api networkPeering listPeeringConnections :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns details about all network peering connections in the specified project.Returns details about all network peering connections in the specified project. + 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. -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 a3a1259e3d..59af472b98 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt @@ -12,10 +12,12 @@ 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.Returns details about all network peering containers in the specified project for the specified cloud provider. + 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. -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 7a6ba3406b..f9ec3617ed 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringContainers.txt @@ -12,10 +12,12 @@ atlas api networkPeering listPeeringContainers :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns details about all network peering containers in the specified project.Returns details about all network peering containers in the specified project. + 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. -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 42def7623e..8f0f3be943 100644 --- a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt @@ -12,10 +12,12 @@ atlas api networkPeering updatePeeringConnection :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates one specified network peering connection in the specified project.Updates one specified network peering connection in the specified project. + 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. -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 06185af7ff..094c62c628 100644 --- a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt @@ -12,10 +12,12 @@ 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.Updates the network details and labels of one specified network peering container in the specified project. + 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. -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 a899ac7f1d..77deb2ddbb 100644 --- a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt +++ b/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt @@ -12,10 +12,12 @@ 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.Verifies if someone set the specified project to Connect via Peering Only mode. + 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. -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 3e64aad3a1..f1a897f3c8 100644 --- a/docs/command/atlas-api-networkPeering.txt +++ b/docs/command/atlas-api-networkPeering.txt @@ -12,10 +12,12 @@ atlas api networkPeering :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes network peering containers and peering connections.Returns, adds, edits, and removes network peering containers and peering connections. + 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. -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,58 +56,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-networkPeering-createPeeringConnection` - 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. - -Creates one new network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-createPeeringContainer` - 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. - -Creates one new network peering container in the specified project. -* :ref:`atlas-api-networkPeering-deletePeeringConnection` - 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. - -Removes one network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-deletePeeringContainer` - 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. - -Removes one network peering container in the specified project. -* :ref:`atlas-api-networkPeering-disablePeering` - 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. - -Disables Connect via Peering Only mode for the specified project. -* :ref:`atlas-api-networkPeering-getPeeringConnection` - 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. - -Returns details about one specified network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-getPeeringContainer` - 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. - -Returns details about one network peering container in one specified project. -* :ref:`atlas-api-networkPeering-listPeeringConnections` - 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. - -Returns details about all network peering connections in the specified project. -* :ref:`atlas-api-networkPeering-listPeeringContainerByCloudProvider` - 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. - -Returns details about all network peering containers in the specified project for the specified cloud provider. -* :ref:`atlas-api-networkPeering-listPeeringContainers` - 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. - -Returns details about all network peering containers in the specified project. -* :ref:`atlas-api-networkPeering-updatePeeringConnection` - 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. - -Updates one specified network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-updatePeeringContainer` - 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. - -Updates the network details and labels of one specified network peering container in the specified project. -* :ref:`atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject` - 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. - -Verifies if someone set the specified project to Connect via Peering Only mode. +* :ref:`atlas-api-networkPeering-createPeeringConnection` - `Public Preview: please provide feedback `_: Creates one new network peering connection in the specified project.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.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.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.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.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.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.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.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.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.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.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.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.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 533c5c6949..b66c864642 100644 --- a/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt @@ -12,10 +12,12 @@ atlas api onlineArchive createOnlineArchive :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one online archive.Creates one online archive. + 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. -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 3e58ec09a7..7d20d9c5f1 100644 --- a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt @@ -12,10 +12,12 @@ atlas api onlineArchive deleteOnlineArchive :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one online archive.Removes one online archive. + 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. -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 f4ae6dde7e..6f81deec66 100644 --- a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt +++ b/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt @@ -12,10 +12,12 @@ atlas api onlineArchive downloadOnlineArchiveQueryLogs :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Downloads query logs for the specified online archive.Downloads query logs for the specified online archive. + 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. -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 5f2cf4a5fd..d4da48c348 100644 --- a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt @@ -12,10 +12,12 @@ atlas api onlineArchive getOnlineArchive :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one online archive for one cluster.Returns one online archive for one cluster. + 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. -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 885ad26e17..5406149bc1 100644 --- a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt +++ b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt @@ -12,10 +12,12 @@ atlas api onlineArchive listOnlineArchives :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns details of all online archives.Returns details of all online archives. + 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. -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 fef015e41c..5b4ec26020 100644 --- a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt @@ -12,10 +12,12 @@ atlas api onlineArchive updateOnlineArchive :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates, pauses, or resumes one online archive.Updates, pauses, or resumes one online archive. + 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. -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 cb7b9e5e7d..3ec784ad77 100644 --- a/docs/command/atlas-api-onlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive.txt @@ -12,10 +12,14 @@ atlas api onlineArchive :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, edits, or removes an online archive.Returns, adds, edits, or removes an online archive. + 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. -Returns, adds, edits, or removes an online archive. + + + Options ------- @@ -52,30 +56,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-onlineArchive-createOnlineArchive` - 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. - -Creates one online archive. -* :ref:`atlas-api-onlineArchive-deleteOnlineArchive` - 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. - -Removes one online archive. -* :ref:`atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs` - 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. - -Downloads query logs for the specified online archive. -* :ref:`atlas-api-onlineArchive-getOnlineArchive` - 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. - -Returns one online archive for one cluster. -* :ref:`atlas-api-onlineArchive-listOnlineArchives` - 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. - -Returns details of all online archives. -* :ref:`atlas-api-onlineArchive-updateOnlineArchive` - 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. - -Updates, pauses, or resumes one online archive. +* :ref:`atlas-api-onlineArchive-createOnlineArchive` - `Public Preview: please provide feedback `_: Creates one online archive.Creates one online archive. +* :ref:`atlas-api-onlineArchive-deleteOnlineArchive` - `Public Preview: please provide feedback `_: Removes one online archive.Removes one online archive. +* :ref:`atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs` - `Public Preview: please provide feedback `_: Downloads query logs for the specified online archive.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.Returns one online archive for one cluster. +* :ref:`atlas-api-onlineArchive-listOnlineArchives` - `Public Preview: please provide feedback `_: Returns details of all online archives.Returns details of all online archives. +* :ref:`atlas-api-onlineArchive-updateOnlineArchive` - `Public Preview: please provide feedback `_: Updates, pauses, or resumes one online archive.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 711c3bfdf6..29ab30d827 100644 --- a/docs/command/atlas-api-organizations-createOrganization.txt +++ b/docs/command/atlas-api-organizations-createOrganization.txt @@ -12,10 +12,12 @@ 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.Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. + 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. -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 5f4445b49b..72d10a88ba 100644 --- a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-createOrganizationInvitation.txt @@ -12,10 +12,12 @@ atlas api organizations createOrganizationInvitation :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Invites one MongoDB Cloud user to join the specified organization.Invites one MongoDB Cloud user to join the specified organization. + 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. -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 2c0496ec02..2215fa4f75 100644 --- a/docs/command/atlas-api-organizations-deleteOrganization.txt +++ b/docs/command/atlas-api-organizations-deleteOrganization.txt @@ -12,10 +12,12 @@ atlas api organizations deleteOrganization :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one specified organization.Removes one specified organization. + 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. -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 71231db074..801d3ea008 100644 --- a/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt @@ -12,10 +12,12 @@ 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.Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. + 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. -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 c081358817..b6e9eb0048 100644 --- a/docs/command/atlas-api-organizations-getOrganization.txt +++ b/docs/command/atlas-api-organizations-getOrganization.txt @@ -12,10 +12,12 @@ 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.Returns one organization to which the requesting Service Account or API Key has 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. -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 77c5045b0d..1c82f5263f 100644 --- a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-getOrganizationInvitation.txt @@ -12,10 +12,12 @@ atlas api organizations getOrganizationInvitation :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the details of one pending invitation to the specified organization.Returns the details of one pending invitation to the specified organization. + 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. -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 dc7a7784b7..12b1084edd 100644 --- a/docs/command/atlas-api-organizations-getOrganizationSettings.txt +++ b/docs/command/atlas-api-organizations-getOrganizationSettings.txt @@ -12,10 +12,12 @@ atlas api organizations getOrganizationSettings :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns details about the specified organization's settings.Returns details about the specified organization's settings. + 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. -Returns details about the specified 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-listOrganizationInvitations.txt b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt index 756ba3fc0a..d88e608b4e 100644 --- a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt +++ b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt @@ -12,10 +12,12 @@ atlas api organizations listOrganizationInvitations :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all pending invitations to the specified organization.Returns all pending invitations to the specified organization. + 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. -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 3277ef45fa..86c049f13c 100644 --- a/docs/command/atlas-api-organizations-listOrganizationProjects.txt +++ b/docs/command/atlas-api-organizations-listOrganizationProjects.txt @@ -12,10 +12,12 @@ atlas api organizations listOrganizationProjects :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns multiple projects in the specified organization.Returns multiple projects in the specified organization. + 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. -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 b076a74eda..8b98f953ef 100644 --- a/docs/command/atlas-api-organizations-listOrganizations.txt +++ b/docs/command/atlas-api-organizations-listOrganizations.txt @@ -12,10 +12,12 @@ 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.Returns all organizations to which the requesting Service Account or API Key has 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. -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 ecd7b3ff01..c674c98936 100644 --- a/docs/command/atlas-api-organizations-updateOrganization.txt +++ b/docs/command/atlas-api-organizations-updateOrganization.txt @@ -12,10 +12,12 @@ atlas api organizations updateOrganization :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates one organization.Updates one organization. + 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. -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 572ab9b14e..fd4f88f21a 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt @@ -12,10 +12,12 @@ 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.Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. + 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. -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 088e32e16c..1851857d5b 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt @@ -12,10 +12,12 @@ 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.Updates the details of one pending invitation, identified by its unique ID, to the specified organization. + 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. -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 4e8ca8af8c..8417b1c215 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationRoles.txt @@ -12,10 +12,12 @@ atlas api organizations updateOrganizationRoles :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates the roles of the specified user in the specified organization.Updates the roles of the specified user in the specified organization. + 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. -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 524137555f..9ffba1bbe4 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationSettings.txt @@ -12,10 +12,12 @@ atlas api organizations updateOrganizationSettings :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates the organization's settings.Updates the organization's settings. + 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. -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 8ee879dd6b..f229d4ceec 100644 --- a/docs/command/atlas-api-organizations.txt +++ b/docs/command/atlas-api-organizations.txt @@ -12,10 +12,14 @@ atlas api organizations :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, and edits organizational units in MongoDB Cloud.Returns, adds, and edits organizational units in MongoDB Cloud. + 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. -Returns, adds, and edits organizational units in MongoDB Cloud. + + + Options ------- @@ -52,66 +56,21 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-organizations-createOrganization` - 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. - -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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. -* :ref:`atlas-api-organizations-deleteOrganization` - 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. - -Removes one specified organization. -* :ref:`atlas-api-organizations-deleteOrganizationInvitation` - 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. - -Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. -* :ref:`atlas-api-organizations-getOrganization` - 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. - -Returns one organization to which the requesting Service Account or API Key has access. -* :ref:`atlas-api-organizations-getOrganizationInvitation` - 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. - -Returns the details of one pending invitation to the specified organization. -* :ref:`atlas-api-organizations-getOrganizationSettings` - 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. - -Returns details about the specified organization's settings. -* :ref:`atlas-api-organizations-listOrganizationInvitations` - 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. - -Returns all pending invitations to the specified organization. -* :ref:`atlas-api-organizations-listOrganizationProjects` - 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. - -Returns multiple projects in the specified organization. -* :ref:`atlas-api-organizations-listOrganizations` - 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. - -Returns all organizations to which the requesting Service Account or API Key has access. -* :ref:`atlas-api-organizations-updateOrganization` - 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. - -Updates one organization. -* :ref:`atlas-api-organizations-updateOrganizationInvitation` - 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. - -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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. -* :ref:`atlas-api-organizations-updateOrganizationRoles` - 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. - -Updates the roles of the specified user in the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationSettings` - 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. - -Updates the organization's settings. +* :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.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.Invites one MongoDB Cloud user to join the specified organization. +* :ref:`atlas-api-organizations-deleteOrganization` - `Public Preview: please provide feedback `_: Removes one specified organization.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.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.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.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.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.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.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.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.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.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.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.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.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 65d734e5c6..0937373928 100644 --- a/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt +++ b/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt @@ -12,10 +12,12 @@ 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.Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. + 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. -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 897f809919..1b4669f003 100644 --- a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt +++ b/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt @@ -12,10 +12,12 @@ 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.Enables MongoDB Cloud to use its slow operation threshold for the specified project. + 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. -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 451d74d568..4ffdf4ba3a 100644 --- a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt +++ b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt @@ -12,10 +12,12 @@ atlas api performanceAdvisor getManagedSlowMs :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Get whether the Managed Slow MS feature is enabled.Get whether the Managed Slow MS feature is enabled. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getManagedSlowMs. diff --git a/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt index b738cf0a69..97a88189bd 100644 --- a/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt +++ b/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt @@ -12,10 +12,12 @@ atlas api performanceAdvisor getServerlessAutoIndexing :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Get whether the Serverless Auto Indexing feature is enabled.Get whether the Serverless Auto Indexing feature is enabled. + 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. -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 ec892fb5f7..64b09343f4 100644 --- a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt @@ -12,10 +12,12 @@ atlas api performanceAdvisor listClusterSuggestedIndexes :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests.Returns the indexes that the Performance Advisor suggests. + 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. -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 485879c254..076a76a903 100644 --- a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt @@ -12,10 +12,12 @@ atlas api performanceAdvisor listDropIndexes :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests to drop.Returns the indexes that the Performance Advisor suggests to drop. + 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. -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 ebb3927561..29fe0d91ba 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt @@ -12,10 +12,12 @@ atlas api performanceAdvisor listSchemaAdvice :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the schema suggestions that the Performance Advisor detects.Returns the schema suggestions that the Performance Advisor detects. + 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. -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 1aade18e19..5559e11000 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt @@ -12,10 +12,12 @@ 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.Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. + 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. -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 e4daf5bd19..74ed0e75af 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt @@ -12,10 +12,12 @@ 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.Returns up to 20 namespaces for collections experiencing slow queries on the specified host. + 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. -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 5440402f97..ca4ff96ed0 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt @@ -12,10 +12,12 @@ atlas api performanceAdvisor listSuggestedIndexes :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests.Returns the indexes that the Performance Advisor suggests. + 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. -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 708aae7a47..7c37e00edf 100644 --- a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt +++ b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt @@ -12,10 +12,12 @@ atlas api performanceAdvisor setServerlessAutoIndexing :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Set whether the Serverless Auto Indexing feature is enabled.Set whether the Serverless Auto Indexing feature is enabled. + 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. -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 0d2b8e30e1..7e6c9f2d32 100644 --- a/docs/command/atlas-api-performanceAdvisor.txt +++ b/docs/command/atlas-api-performanceAdvisor.txt @@ -12,10 +12,12 @@ atlas api performanceAdvisor :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns suggested indexes and slow query data for a database deployment.Returns suggested indexes and slow query data for a database deployment. + 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. -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,50 +56,17 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-performanceAdvisor-disableSlowOperationThresholding` - 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. - -Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. -* :ref:`atlas-api-performanceAdvisor-enableSlowOperationThresholding` - 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. - -Enables MongoDB Cloud to use its slow operation threshold for the specified project. -* :ref:`atlas-api-performanceAdvisor-getManagedSlowMs` - 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. - -Get whether the Managed Slow MS feature is enabled. -* :ref:`atlas-api-performanceAdvisor-getServerlessAutoIndexing` - 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. - -Get whether the Serverless Auto Indexing feature is enabled. -* :ref:`atlas-api-performanceAdvisor-listClusterSuggestedIndexes` - 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. - -Returns the indexes that the Performance Advisor suggests. -* :ref:`atlas-api-performanceAdvisor-listDropIndexes` - 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. - -Returns the indexes that the Performance Advisor suggests to drop. -* :ref:`atlas-api-performanceAdvisor-listSchemaAdvice` - 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. - -Returns the schema suggestions that the Performance Advisor detects. -* :ref:`atlas-api-performanceAdvisor-listSlowQueries` - 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. - -Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. -* :ref:`atlas-api-performanceAdvisor-listSlowQueryNamespaces` - 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. - -Returns up to 20 namespaces for collections experiencing slow queries on the specified host. -* :ref:`atlas-api-performanceAdvisor-listSuggestedIndexes` - 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. - -Returns the indexes that the Performance Advisor suggests. -* :ref:`atlas-api-performanceAdvisor-setServerlessAutoIndexing` - 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. - -Set whether the Serverless Auto Indexing feature is enabled. +* :ref:`atlas-api-performanceAdvisor-disableSlowOperationThresholding` - `Public Preview: please provide feedback `_: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project.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.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.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.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.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.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.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.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.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.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.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 3bfacf21d8..8e2e43e0fc 100644 --- a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt @@ -12,10 +12,12 @@ atlas api privateEndpointServices createPrivateEndpoint :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one private endpoint for the specified cloud service provider.Creates one private endpoint for the specified cloud service provider. + 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. -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 44bb405c97..07a9f05876 100644 --- a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt @@ -12,10 +12,12 @@ atlas api privateEndpointServices createPrivateEndpointService :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one private endpoint service for the specified cloud service provider.Creates one private endpoint service for the specified cloud service provider. + 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. -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 9ec4f9d8fe..917179bd82 100644 --- a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt @@ -12,10 +12,12 @@ 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.Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. + 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. -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 0674270600..03cde18edb 100644 --- a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt @@ -12,10 +12,12 @@ atlas api privateEndpointServices deletePrivateEndpointService :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one private endpoint service from the specified project.Removes one private endpoint service from the specified project. + 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. -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 c37154eabc..7dc4eea9a8 100644 --- a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt @@ -12,10 +12,12 @@ atlas api privateEndpointServices getPrivateEndpoint :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the connection state of the specified private endpoint.Returns the connection state of the specified private endpoint. + 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. -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 a7efbc187d..b73c602d94 100644 --- a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt @@ -12,10 +12,12 @@ 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.Returns the name, interfaces, and state of the specified private endpoint service from one project. + 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. -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 b045834919..24b49ebbf1 100644 --- a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt +++ b/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt @@ -12,10 +12,12 @@ 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.Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. + 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. -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 a876d96498..d3a700f2fb 100644 --- a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt +++ b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt @@ -12,10 +12,12 @@ 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.Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. + 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. -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 aa563992ac..13d24545d2 100644 --- a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt +++ b/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt @@ -12,10 +12,12 @@ 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.Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. + 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. -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 d642fd79f0..006bf36e18 100644 --- a/docs/command/atlas-api-privateEndpointServices.txt +++ b/docs/command/atlas-api-privateEndpointServices.txt @@ -12,10 +12,14 @@ atlas api privateEndpointServices :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes private endpoint services.Returns, adds, edits, and removes private endpoint services. + 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. -Returns, adds, edits, and removes private endpoint services. + + + Options ------- @@ -52,42 +56,15 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-privateEndpointServices-createPrivateEndpoint` - 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. - -Creates one private endpoint for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-createPrivateEndpointService` - 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. - -Creates one private endpoint service for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpoint` - 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. - -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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. -* :ref:`atlas-api-privateEndpointServices-getPrivateEndpoint` - 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. - -Returns the connection state of the specified private endpoint. -* :ref:`atlas-api-privateEndpointServices-getPrivateEndpointService` - 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. - -Returns the name, interfaces, and state of the specified private endpoint service from one project. -* :ref:`atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting` - 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. - -Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. -* :ref:`atlas-api-privateEndpointServices-listPrivateEndpointServices` - 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. - -Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting` - 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. - -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` - `Public Preview: please provide feedback `_: Creates one private endpoint for the specified cloud service provider.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.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.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.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.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.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.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.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.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 1eca7f3325..33403b1800 100644 --- a/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt @@ -12,10 +12,12 @@ atlas api programmaticApiKeys addProjectApiKey :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Assigns the specified organization API key to the specified project.Assigns the specified organization API key to the specified project. + 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. -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 a48e56b759..f696541de7 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt @@ -12,10 +12,12 @@ atlas api programmaticApiKeys createApiKey :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one API key for the specified organization.Creates one API key for the specified organization. + 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. -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 8db86d4664..4dd1769f32 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt @@ -12,10 +12,12 @@ atlas api programmaticApiKeys createApiKeyAccessList :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates the access list entries for the specified organization API key.Creates the access list entries for the specified organization API key. + 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. -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 5e26673cd0..35278064ed 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt @@ -12,10 +12,12 @@ 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.Creates and assigns the specified organization API key to the specified project. + 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. -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 9c76e29450..3d954d830b 100644 --- a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt @@ -12,10 +12,12 @@ atlas api programmaticApiKeys deleteApiKey :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one organization API key from the specified organization.Removes one organization API key from the specified organization. + 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. -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 16e4a77382..aef0b0593b 100644 --- a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt +++ b/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt @@ -12,10 +12,12 @@ 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.Removes the specified access list entry from the specified organization API key. + 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. -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 9d5e97066c..8bdb133a73 100644 --- a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt @@ -12,10 +12,12 @@ atlas api programmaticApiKeys getApiKey :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one organization API key.Returns one organization API key. + 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. -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 92b4c3f86f..9ceff6426b 100644 --- a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt +++ b/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt @@ -12,10 +12,12 @@ atlas api programmaticApiKeys getApiKeyAccessList :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one access list entry for the specified organization API key.Returns one access list entry for the specified organization API key. + 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. -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 21598027ba..2f45f040bb 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt @@ -12,10 +12,12 @@ 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.Returns all access list entries that you configured for the specified organization API key. + 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. -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 af85aef85a..3645879bde 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt @@ -12,10 +12,12 @@ atlas api programmaticApiKeys listApiKeys :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all organization API keys for the specified organization.Returns all organization API keys for the specified organization. + 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. -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 f0813166f5..2da5ac264b 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt @@ -12,10 +12,12 @@ 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.Returns all organization API keys that you assigned to the specified project. + 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. -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 384cd8c0d2..e01de6ca50 100644 --- a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt @@ -12,10 +12,12 @@ atlas api programmaticApiKeys removeProjectApiKey :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one organization API key from the specified project.Removes one organization API key from the specified project. + 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. -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 3e32d6d3d5..8a359b549f 100644 --- a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt @@ -12,10 +12,12 @@ atlas api programmaticApiKeys updateApiKey :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates one organization API key in the specified organization.Updates one organization API key in the specified organization. + 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. -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 e10d49fad0..1001eae96f 100644 --- a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt +++ b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt @@ -12,10 +12,12 @@ 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.Updates the roles of the organization API key that you specify for the project that you specify. + 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. -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 bfe8b1d775..6190dd6365 100644 --- a/docs/command/atlas-api-programmaticApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys.txt @@ -12,10 +12,12 @@ 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.Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. + 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. -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,62 +56,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-programmaticApiKeys-addProjectApiKey` - 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. - -Assigns the specified organization API key to the specified project. -* :ref:`atlas-api-programmaticApiKeys-createApiKey` - 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. - -Creates one API key for the specified organization. -* :ref:`atlas-api-programmaticApiKeys-createApiKeyAccessList` - 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. - -Creates the access list entries for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-createProjectApiKey` - 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. - -Creates and assigns the specified organization API key to the specified project. -* :ref:`atlas-api-programmaticApiKeys-deleteApiKey` - 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. - -Removes one organization API key from the specified organization. -* :ref:`atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry` - 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. - -Removes the specified access list entry from the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-getApiKey` - 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. - -Returns one organization API key. -* :ref:`atlas-api-programmaticApiKeys-getApiKeyAccessList` - 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. - -Returns one access list entry for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries` - 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. - -Returns all access list entries that you configured for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-listApiKeys` - 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. - -Returns all organization API keys for the specified organization. -* :ref:`atlas-api-programmaticApiKeys-listProjectApiKeys` - 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. - -Returns all organization API keys that you assigned to the specified project. -* :ref:`atlas-api-programmaticApiKeys-removeProjectApiKey` - 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. - -Removes one organization API key from the specified project. -* :ref:`atlas-api-programmaticApiKeys-updateApiKey` - 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. - -Updates one organization API key in the specified organization. -* :ref:`atlas-api-programmaticApiKeys-updateApiKeyRoles` - 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. - -Updates the roles of the organization API key that you specify for the project that you specify. +* :ref:`atlas-api-programmaticApiKeys-addProjectApiKey` - `Public Preview: please provide feedback `_: Assigns the specified organization API key to the specified project.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.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.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.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.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.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.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.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.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.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.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.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.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.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 b6a01d0415..d23f002574 100644 --- a/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt @@ -12,10 +12,12 @@ atlas api projectIpAccessList createProjectIpAccessList :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Adds one or more access list entries to the specified project.Adds one or more access list entries to the specified project. + 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. -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 bd5a5bc40e..a5939bc708 100644 --- a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt @@ -12,10 +12,12 @@ 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.Removes one access list entry from the specified project's IP access list. + 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. -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 5691110aea..9b62b507b0 100644 --- a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt +++ b/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt @@ -12,10 +12,12 @@ atlas api projectIpAccessList getProjectIpAccessListStatus :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the status of one project IP access list entry.Returns the status of one project IP access list entry. + 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. -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 497df62798..e31ca91cb2 100644 --- a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt +++ b/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt @@ -12,10 +12,12 @@ 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.Returns one access list entry from the specified project's IP access list. + 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. -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 eac439637f..f6a66afb27 100644 --- a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt +++ b/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt @@ -12,10 +12,12 @@ 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.Returns all access list entries from the specified project's IP access list. + 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. -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 01022ee0cd..299fee2f07 100644 --- a/docs/command/atlas-api-projectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList.txt @@ -12,10 +12,12 @@ 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.Returns, adds, edits, and removes network access limits to database deployments in Atlas. + 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. -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,26 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projectIpAccessList-createProjectIpAccessList` - 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. - -Adds one or more access list entries to the specified project. -* :ref:`atlas-api-projectIpAccessList-deleteProjectIpAccessList` - 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. - -Removes one access list entry from the specified project's IP access list. -* :ref:`atlas-api-projectIpAccessList-getProjectIpAccessListStatus` - 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. - -Returns the status of one project IP access list entry. -* :ref:`atlas-api-projectIpAccessList-getProjectIpList` - 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. - -Returns one access list entry from the specified project's IP access list. -* :ref:`atlas-api-projectIpAccessList-listProjectIpAccessLists` - 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. - -Returns all access list entries from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-createProjectIpAccessList` - `Public Preview: please provide feedback `_: Adds one or more access list entries to the specified project.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.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.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.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.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 eff59fec77..b4bd6489d7 100644 --- a/docs/command/atlas-api-projects-addUserToProject.txt +++ b/docs/command/atlas-api-projects-addUserToProject.txt @@ -12,10 +12,12 @@ atlas api projects addUserToProject :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to the specified project.Adds one MongoDB Cloud user to the specified project. + 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. -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 4f11c8e000..1b25c8246d 100644 --- a/docs/command/atlas-api-projects-createProject.txt +++ b/docs/command/atlas-api-projects-createProject.txt @@ -12,10 +12,12 @@ atlas api projects createProject :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one project.Creates one project. + 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. -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 7b2167d9b2..3e38f037bf 100644 --- a/docs/command/atlas-api-projects-createProjectInvitation.txt +++ b/docs/command/atlas-api-projects-createProjectInvitation.txt @@ -12,10 +12,12 @@ atlas api projects createProjectInvitation :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Invites one MongoDB Cloud user to join the specified project.Invites one MongoDB Cloud user to join the specified project. + 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. -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 f49b37cf69..2e61c71dad 100644 --- a/docs/command/atlas-api-projects-deleteProject.txt +++ b/docs/command/atlas-api-projects-deleteProject.txt @@ -12,10 +12,12 @@ atlas api projects deleteProject :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes the specified project.Removes the specified project. + 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. -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 a82212adb7..f46842a6ff 100644 --- a/docs/command/atlas-api-projects-deleteProjectInvitation.txt +++ b/docs/command/atlas-api-projects-deleteProjectInvitation.txt @@ -12,10 +12,12 @@ 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.Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. + 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. -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 25e37ddd4d..d4eb45b33c 100644 --- a/docs/command/atlas-api-projects-deleteProjectLimit.txt +++ b/docs/command/atlas-api-projects-deleteProjectLimit.txt @@ -12,10 +12,12 @@ atlas api projects deleteProjectLimit :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes the specified project limit.Removes the specified project limit. + 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. -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 00bb02b8ac..234a254b66 100644 --- a/docs/command/atlas-api-projects-getProject.txt +++ b/docs/command/atlas-api-projects-getProject.txt @@ -12,10 +12,12 @@ atlas api projects getProject :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns details about the specified project.Returns details about the specified project. + 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. -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 2616c53eee..b9d9d61a17 100644 --- a/docs/command/atlas-api-projects-getProjectByName.txt +++ b/docs/command/atlas-api-projects-getProjectByName.txt @@ -12,10 +12,12 @@ atlas api projects getProjectByName :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns details about the project identified by its name.Returns details about the project identified by its name. + 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. -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 871522180f..70687bc507 100644 --- a/docs/command/atlas-api-projects-getProjectInvitation.txt +++ b/docs/command/atlas-api-projects-getProjectInvitation.txt @@ -12,10 +12,12 @@ atlas api projects getProjectInvitation :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the details of one pending invitation to the specified project.Returns the details of one pending invitation to the specified project. + 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. -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 35b6ade4d4..7ed5bf9479 100644 --- a/docs/command/atlas-api-projects-getProjectLimit.txt +++ b/docs/command/atlas-api-projects-getProjectLimit.txt @@ -12,10 +12,12 @@ atlas api projects getProjectLimit :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the specified limit for the specified project.Returns the specified limit for the specified project. + 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. -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 d36eb987a8..ca3ff71404 100644 --- a/docs/command/atlas-api-projects-getProjectLtsVersions.txt +++ b/docs/command/atlas-api-projects-getProjectLtsVersions.txt @@ -12,10 +12,12 @@ 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.Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLtsVersions. diff --git a/docs/command/atlas-api-projects-getProjectSettings.txt b/docs/command/atlas-api-projects-getProjectSettings.txt index 3112feca4a..27ef37a5a4 100644 --- a/docs/command/atlas-api-projects-getProjectSettings.txt +++ b/docs/command/atlas-api-projects-getProjectSettings.txt @@ -12,10 +12,12 @@ atlas api projects getProjectSettings :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns details about the specified project's settings.Returns details about the specified project's settings. + 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. -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 6aaf2539b5..3982129280 100644 --- a/docs/command/atlas-api-projects-listProjectInvitations.txt +++ b/docs/command/atlas-api-projects-listProjectInvitations.txt @@ -12,10 +12,12 @@ atlas api projects listProjectInvitations :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all pending invitations to the specified project.Returns all pending invitations to the specified project. + 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. -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 a9c945db95..dcbae6102a 100644 --- a/docs/command/atlas-api-projects-listProjectLimits.txt +++ b/docs/command/atlas-api-projects-listProjectLimits.txt @@ -12,10 +12,12 @@ atlas api projects listProjectLimits :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all the limits for the specified project.Returns all the limits for the specified project. + 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. -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 6f3f25d1fd..b3e2a8f896 100644 --- a/docs/command/atlas-api-projects-listProjects.txt +++ b/docs/command/atlas-api-projects-listProjects.txt @@ -12,10 +12,12 @@ atlas api projects listProjects :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns details about all projects.Returns details about all projects. + 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. -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 f1eba66536..eb268562cf 100644 --- a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt +++ b/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt @@ -12,10 +12,12 @@ atlas api projects migrateProjectToAnotherOrg :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Migrates a project from its current organization to another organization.Migrates a project from its current organization to another organization. + 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. -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 8c9fd5719f..53b23ff3a6 100644 --- a/docs/command/atlas-api-projects-returnAllIpAddresses.txt +++ b/docs/command/atlas-api-projects-returnAllIpAddresses.txt @@ -12,10 +12,12 @@ atlas api projects returnAllIpAddresses :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all IP addresses for this project.Returns all IP addresses for this project. + 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. -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 ffeac40c4e..b123e43998 100644 --- a/docs/command/atlas-api-projects-setProjectLimit.txt +++ b/docs/command/atlas-api-projects-setProjectLimit.txt @@ -12,10 +12,12 @@ atlas api projects setProjectLimit :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Sets the specified project limit.Sets the specified project limit. + 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. -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 fd9a33df58..56f56cf293 100644 --- a/docs/command/atlas-api-projects-updateProject.txt +++ b/docs/command/atlas-api-projects-updateProject.txt @@ -12,10 +12,12 @@ 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.Updates the human-readable label that identifies the specified project, or the tags associated with the project. + 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. -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 d336d6d0c3..43895c2172 100644 --- a/docs/command/atlas-api-projects-updateProjectInvitation.txt +++ b/docs/command/atlas-api-projects-updateProjectInvitation.txt @@ -12,10 +12,12 @@ 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.Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. + 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. -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 f0ec6c6199..223eddf95b 100644 --- a/docs/command/atlas-api-projects-updateProjectInvitationById.txt +++ b/docs/command/atlas-api-projects-updateProjectInvitationById.txt @@ -12,10 +12,12 @@ 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.Updates the details of one pending invitation, identified by its unique ID, to the specified project. + 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. -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 2411ac9c93..f5548b661d 100644 --- a/docs/command/atlas-api-projects-updateProjectRoles.txt +++ b/docs/command/atlas-api-projects-updateProjectRoles.txt @@ -12,10 +12,12 @@ atlas api projects updateProjectRoles :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates the roles of the specified user in the specified project.Updates the roles of the specified user in the specified project. + 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. -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 be348ca707..0ea8958995 100644 --- a/docs/command/atlas-api-projects-updateProjectSettings.txt +++ b/docs/command/atlas-api-projects-updateProjectSettings.txt @@ -12,10 +12,12 @@ atlas api projects updateProjectSettings :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates the settings of the specified project.Updates the settings of the specified project. + 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. -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 873fa4d5b3..72045d9682 100644 --- a/docs/command/atlas-api-projects.txt +++ b/docs/command/atlas-api-projects.txt @@ -12,10 +12,14 @@ atlas api projects :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, and edits collections of clusters and users in MongoDB Cloud.Returns, adds, and edits collections of clusters and users in MongoDB Cloud. + 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. -Returns, adds, and edits collections of clusters and users in MongoDB Cloud. + + + Options ------- @@ -52,98 +56,29 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projects-addUserToProject` - 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. - -Adds one MongoDB Cloud user to the specified project. -* :ref:`atlas-api-projects-createProject` - 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. - -Creates one project. -* :ref:`atlas-api-projects-createProjectInvitation` - 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. - -Invites one MongoDB Cloud user to join the specified project. -* :ref:`atlas-api-projects-deleteProject` - 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. - -Removes the specified project. -* :ref:`atlas-api-projects-deleteProjectInvitation` - 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. - -Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. -* :ref:`atlas-api-projects-deleteProjectLimit` - 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. - -Removes the specified project limit. -* :ref:`atlas-api-projects-getProject` - 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. - -Returns details about the specified project. -* :ref:`atlas-api-projects-getProjectByName` - 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. - -Returns details about the project identified by its name. -* :ref:`atlas-api-projects-getProjectInvitation` - 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. - -Returns the details of one pending invitation to the specified project. -* :ref:`atlas-api-projects-getProjectLimit` - 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. - -Returns the specified limit for the specified project. -* :ref:`atlas-api-projects-getProjectLtsVersions` - 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. - -Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. -* :ref:`atlas-api-projects-getProjectSettings` - 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. - -Returns details about the specified project's settings. -* :ref:`atlas-api-projects-listProjectInvitations` - 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. - -Returns all pending invitations to the specified project. -* :ref:`atlas-api-projects-listProjectLimits` - 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. - -Returns all the limits for the specified project. -* :ref:`atlas-api-projects-listProjects` - 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. - -Returns details about all projects. -* :ref:`atlas-api-projects-migrateProjectToAnotherOrg` - 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. - -Migrates a project from its current organization to another organization. -* :ref:`atlas-api-projects-returnAllIpAddresses` - 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. - -Returns all IP addresses for this project. -* :ref:`atlas-api-projects-setProjectLimit` - 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. - -Sets the specified project limit. -* :ref:`atlas-api-projects-updateProject` - 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. - -Updates the human-readable label that identifies the specified project, or the tags associated with the project. -* :ref:`atlas-api-projects-updateProjectInvitation` - 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. - -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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. -* :ref:`atlas-api-projects-updateProjectRoles` - 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. - -Updates the roles of the specified user in the specified project. -* :ref:`atlas-api-projects-updateProjectSettings` - 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. - -Updates the settings of the specified project. +* :ref:`atlas-api-projects-addUserToProject` - `Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to the specified project.Adds one MongoDB Cloud user to the specified project. +* :ref:`atlas-api-projects-createProject` - `Public Preview: please provide feedback `_: Creates one project.Creates one project. +* :ref:`atlas-api-projects-createProjectInvitation` - `Public Preview: please provide feedback `_: Invites one MongoDB Cloud user to join the specified project.Invites one MongoDB Cloud user to join the specified project. +* :ref:`atlas-api-projects-deleteProject` - `Public Preview: please provide feedback `_: Removes the specified project.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.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.Removes the specified project limit. +* :ref:`atlas-api-projects-getProject` - `Public Preview: please provide feedback `_: Returns details about the specified project.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.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.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.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.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.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.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.Returns all the limits for the specified project. +* :ref:`atlas-api-projects-listProjects` - `Public Preview: please provide feedback `_: Returns details about all projects.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.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.Returns all IP addresses for this project. +* :ref:`atlas-api-projects-setProjectLimit` - `Public Preview: please provide feedback `_: Sets the specified project limit.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.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.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.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.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.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 768a092e72..0f9bbf9893 100644 --- a/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt @@ -12,10 +12,12 @@ 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.Configures the project level settings for the push-based log export feature. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/createPushBasedLogConfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt index a17122978c..fbc26db6c0 100644 --- a/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt @@ -12,10 +12,12 @@ 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.Disables the push-based log export feature by resetting the project level settings to its default configuration. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/deletePushBasedLogConfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt index 6a4cd34fd3..cd4f5e4a8b 100644 --- a/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt @@ -12,10 +12,12 @@ 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.Fetches the current project level settings for the push-based log export feature. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/getPushBasedLogConfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt index a3d30c068f..23afd1407a 100644 --- a/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt @@ -12,10 +12,12 @@ 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.Updates the project level settings for the push-based log export feature. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/updatePushBasedLogConfiguration. diff --git a/docs/command/atlas-api-pushBasedLogExport.txt b/docs/command/atlas-api-pushBasedLogExport.txt index f717281f23..2c86c299cd 100644 --- a/docs/command/atlas-api-pushBasedLogExport.txt +++ b/docs/command/atlas-api-pushBasedLogExport.txt @@ -12,10 +12,12 @@ 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.You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. + 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. -You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. + Atlas exports logs every 5 minutes. @@ -54,22 +56,10 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-pushBasedLogExport-createPushBasedLogConfiguration` - 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. - -Configures the project level settings for the push-based log export feature. -* :ref:`atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration` - 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. - -Disables the push-based log export feature by resetting the project level settings to its default configuration. -* :ref:`atlas-api-pushBasedLogExport-getPushBasedLogConfiguration` - 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. - -Fetches the current project level settings for the push-based log export feature. -* :ref:`atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration` - 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. - -Updates the project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-createPushBasedLogConfiguration` - `Public Preview: please provide feedback `_: Configures the project level settings for the push-based log export feature.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.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.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.Updates the project level settings for the push-based log export feature. .. toctree:: diff --git a/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt index 463dbf9f69..62facd3b35 100644 --- a/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt @@ -12,10 +12,12 @@ atlas api resourcePolicies createAtlasResourcePolicy :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Create one Atlas Resource Policy for an org.Create one Atlas Resource Policy for an org. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/createAtlasResourcePolicy. diff --git a/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt index 3ad00f734b..c116be78cd 100644 --- a/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt @@ -12,10 +12,12 @@ atlas api resourcePolicies deleteAtlasResourcePolicy :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Delete one Atlas Resource Policy for an org.Delete one Atlas Resource Policy for an org. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/deleteAtlasResourcePolicy. diff --git a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt index fdc55e27d8..b211968823 100644 --- a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt @@ -12,10 +12,12 @@ atlas api resourcePolicies getAtlasResourcePolicies :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Return all Atlas Resource Policies for the org.Return all Atlas Resource Policies for the org. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicies. diff --git a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt index 8b157f9ca2..2d94c21f46 100644 --- a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt @@ -12,10 +12,12 @@ atlas api resourcePolicies getAtlasResourcePolicy :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Return one Atlas Resource Policy for an org.Return one Atlas Resource Policy for an org. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicy. diff --git a/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt b/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt index 8d158cd735..7ff6a68e35 100644 --- a/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt +++ b/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt @@ -12,10 +12,12 @@ atlas api resourcePolicies getResourcesNonCompliant :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Return all non-compliant resources for an org.Return all non-compliant resources for an org. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getResourcesNonCompliant. diff --git a/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt index f53ac3da84..1dffc53db3 100644 --- a/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt @@ -12,10 +12,12 @@ atlas api resourcePolicies updateAtlasResourcePolicy :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Update one Atlas Resource Policy for an org.Update one Atlas Resource Policy for an org. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/updateAtlasResourcePolicy. diff --git a/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt index 91c572c0fc..99c7854f02 100644 --- a/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt @@ -12,10 +12,12 @@ atlas api resourcePolicies validateAtlasResourcePolicy :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Validate one Atlas Resource Policy for an org.Validate one Atlas Resource Policy for an org. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/validateAtlasResourcePolicy. diff --git a/docs/command/atlas-api-resourcePolicies.txt b/docs/command/atlas-api-resourcePolicies.txt index 1dfcd868e3..a19914fbee 100644 --- a/docs/command/atlas-api-resourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies.txt @@ -12,10 +12,14 @@ atlas api resourcePolicies :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Configure and manage Atlas Resource Policies within your organization.Configure and manage Atlas Resource Policies within your organization. + 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. -Configure and manage Atlas Resource Policies within your organization. + + + Options ------- @@ -52,34 +56,13 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-resourcePolicies-createAtlasResourcePolicy` - 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. - -Create one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-deleteAtlasResourcePolicy` - 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. - -Delete one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicies` - 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. - -Return all Atlas Resource Policies for the org. -* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicy` - 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. - -Return one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getResourcesNonCompliant` - 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. - -Return all non-compliant resources for an org. -* :ref:`atlas-api-resourcePolicies-updateAtlasResourcePolicy` - 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. - -Update one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-validateAtlasResourcePolicy` - 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. - -Validate one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-createAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Create one Atlas Resource Policy for an org.Create one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-deleteAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Delete one Atlas Resource Policy for an org.Delete one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicies` - `Public Preview: please provide feedback `_: Return all Atlas Resource Policies for the org.Return all Atlas Resource Policies for the org. +* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Return one Atlas Resource Policy for an org.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.Return all non-compliant resources for an org. +* :ref:`atlas-api-resourcePolicies-updateAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Update one Atlas Resource Policy for an org.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.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 2457c08e66..75c1726c5a 100644 --- a/docs/command/atlas-api-rollingIndex-createRollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex-createRollingIndex.txt @@ -12,10 +12,12 @@ 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.Creates an index on the cluster identified by its name in a rolling manner. + 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. -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 044d986194..a86eebf697 100644 --- a/docs/command/atlas-api-rollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex.txt @@ -12,10 +12,12 @@ atlas api rollingIndex :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one index to a database deployment in a rolling manner.Creates one index to a database deployment in a rolling manner. + 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. -Creates one index to a database deployment in a rolling manner. + You can't create a rolling index on an M0 free cluster or M2/M5 shared cluster. @@ -54,10 +56,7 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-rollingIndex-createRollingIndex` - 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. - -Creates an index on the cluster identified by its name in a rolling manner. +* :ref:`atlas-api-rollingIndex-createRollingIndex` - `Public Preview: please provide feedback `_: Creates an index on the cluster identified by its name in a rolling manner.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 c31bf71e26..a21894e1b3 100644 --- a/docs/command/atlas-api-root-getSystemStatus.txt +++ b/docs/command/atlas-api-root-getSystemStatus.txt @@ -12,10 +12,12 @@ 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.This resource returns information about the MongoDB application along with API key meta data. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Root/operation/getSystemStatus. diff --git a/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt b/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt index 80fce4d35c..10a308c907 100644 --- a/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt +++ b/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt @@ -12,10 +12,12 @@ atlas api root returnAllControlPlaneIpAddresses :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all control plane IP addresses.Returns all control plane IP addresses. + 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. -Returns all control plane IP addresses. + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/returnAllControlPlaneIpAddresses. diff --git a/docs/command/atlas-api-root.txt b/docs/command/atlas-api-root.txt index 3bde6dd02d..6cea237811 100644 --- a/docs/command/atlas-api-root.txt +++ b/docs/command/atlas-api-root.txt @@ -12,10 +12,12 @@ 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.Returns details that describe the MongoDB Cloud build and the access token that requests this resource. + 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. -Returns details that describe the MongoDB Cloud build and the access token that requests this resource. + This starts the MongoDB Cloud API. @@ -54,14 +56,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-root-getSystemStatus` - 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. - -This resource returns information about the MongoDB application along with API key meta data. -* :ref:`atlas-api-root-returnAllControlPlaneIpAddresses` - 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. - -Returns all control plane IP addresses. +* :ref:`atlas-api-root-getSystemStatus` - `Public Preview: please provide feedback `_: This resource returns information about the MongoDB application along with API key meta data.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.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 d70856c523..6f22a9495d 100644 --- a/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt @@ -12,10 +12,12 @@ 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.Update as of Feb 2025: This endpoint now creates a Flex cluster instead. + 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. -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 c29403d65e..9e526c85a3 100644 --- a/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt @@ -12,10 +12,12 @@ atlas api serverlessInstances deleteServerlessInstance :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one serverless instance from the specified project.Removes one serverless instance from the specified project. + 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. -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 c1bc231ac6..ed9d65f157 100644 --- a/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt @@ -12,10 +12,12 @@ atlas api serverlessInstances getServerlessInstance :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns details for one serverless instance in the specified project.Returns details for one serverless instance in the specified project. + 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. -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 f1166ded7f..886aa6e85a 100644 --- a/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt +++ b/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt @@ -12,10 +12,12 @@ atlas api serverlessInstances listServerlessInstances :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns details for all serverless instances in the specified project.Returns details for all serverless instances in the specified project. + 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. -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 53274119a3..a8b48a60df 100644 --- a/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt @@ -12,10 +12,12 @@ atlas api serverlessInstances updateServerlessInstance :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates one serverless instance in the specified project.Updates one serverless instance in the specified project. + 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. -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 f3a46009ec..ae0c71afc5 100644 --- a/docs/command/atlas-api-serverlessInstances.txt +++ b/docs/command/atlas-api-serverlessInstances.txt @@ -12,10 +12,14 @@ atlas api serverlessInstances :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes serverless instances.Returns, adds, edits, and removes serverless instances. + 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. -Returns, adds, edits, and removes serverless instances. + + + Options ------- @@ -52,26 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serverlessInstances-createServerlessInstance` - 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. - -Update as of Feb 2025: This endpoint now creates a Flex cluster instead. -* :ref:`atlas-api-serverlessInstances-deleteServerlessInstance` - 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. - -Removes one serverless instance from the specified project. -* :ref:`atlas-api-serverlessInstances-getServerlessInstance` - 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. - -Returns details for one serverless instance in the specified project. -* :ref:`atlas-api-serverlessInstances-listServerlessInstances` - 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. - -Returns details for all serverless instances in the specified project. -* :ref:`atlas-api-serverlessInstances-updateServerlessInstance` - 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. - -Updates one serverless instance in the specified project. +* :ref:`atlas-api-serverlessInstances-createServerlessInstance` - `Public Preview: please provide feedback `_: Update as of Feb 2025: This endpoint now creates a Flex cluster instead.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.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.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.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.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 79615cf0d6..bb52897c9a 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt @@ -12,10 +12,12 @@ atlas api serverlessPrivateEndpoints createServerlessPrivateEndpoint :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one private endpoint for one serverless instance.Creates one private endpoint for one serverless instance. + 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. -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 facb7ffd98..a9a6c59574 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt @@ -12,10 +12,12 @@ atlas api serverlessPrivateEndpoints deleteServerlessPrivateEndpoint :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Remove one private endpoint from one serverless instance.Remove one private endpoint from one serverless instance. + 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. -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 aa250905d3..db302a3ef0 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt @@ -12,10 +12,12 @@ atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Return one private endpoint for one serverless instance.Return one private endpoint for one serverless instance. + 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. -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 5e429b4abf..24d95a14e0 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt @@ -12,10 +12,12 @@ atlas api serverlessPrivateEndpoints listServerlessPrivateEndpoints :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all private endpoints for one serverless instance.Returns all private endpoints for one serverless instance. + 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. -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 a7c4b9e6e6..3c2bbb661b 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt @@ -12,10 +12,12 @@ atlas api serverlessPrivateEndpoints updateServerlessPrivateEndpoint :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates one private endpoint for one serverless instance.Updates one private endpoint for one serverless instance. + 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. -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 96133268b6..d59f13fc21 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints.txt @@ -12,10 +12,12 @@ atlas api serverlessPrivateEndpoints :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes private endpoints for serverless instances.Returns, adds, edits, and removes private endpoints for serverless instances. + 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. -Returns, adds, edits, and removes private endpoints for serverless instances. + To learn more, see the Atlas Administration API tab on the following tutorial. @@ -54,26 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint` - 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. - -Creates one private endpoint for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint` - 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. - -Remove one private endpoint from one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint` - 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. - -Return one private endpoint for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints` - 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. - -Returns all private endpoints for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint` - 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. - -Updates one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint` - `Public Preview: please provide feedback `_: Creates one private endpoint for one serverless instance.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.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.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.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.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 4f77e9bec2..466659492f 100644 --- a/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt @@ -12,10 +12,12 @@ atlas api serviceAccounts addProjectServiceAccount :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Assigns the specified Service Account to the specified Project.Assigns the specified Service Account to the specified Project. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/addProjectServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt index 01263c3bc2..bc43cdc552 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt @@ -12,10 +12,12 @@ atlas api serviceAccounts createProjectServiceAccount :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one Service Account for the specified Project.Creates one Service Account for the specified Project. + 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. -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 ebd1e488a9..a29568a74e 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt @@ -12,10 +12,12 @@ 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.Add Access List Entries for the specified Service Account for the project. + 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. -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 102a98ce28..b6a78b1fb1 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt @@ -12,10 +12,12 @@ 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.Create a secret for the specified Service Account in the specified Project. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountSecret. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt index 0606f6e5f6..6c6690bc90 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt @@ -12,10 +12,12 @@ atlas api serviceAccounts createServiceAccount :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one Service Account for the specified Organization.Creates one Service Account for the specified Organization. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt index 265d287991..974151ee3a 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt @@ -12,10 +12,12 @@ 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.Add Access List Entries for the specified Service Account for the organization. + 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. -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 4807aece49..4fbb4448e2 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt @@ -12,10 +12,12 @@ atlas api serviceAccounts createServiceAccountSecret :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Create a secret for the specified Service Account.Create a secret for the specified Service Account. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountSecret. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt index 93fc674979..51e07b3090 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt @@ -12,10 +12,12 @@ atlas api serviceAccounts deleteProjectServiceAccount :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes the specified Service Account from the specified project.Removes the specified Service Account from the specified project. + 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. -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 6684625336..28fa0b109e 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt @@ -12,10 +12,12 @@ 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.Removes the specified access list entry from the specified Service Account for the project. + 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. -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 5b707171b9..b9bfabce39 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt @@ -12,10 +12,12 @@ atlas api serviceAccounts deleteProjectServiceAccountSecret :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Deletes the specified Service Account secret.Deletes the specified Service Account secret. + 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. -Deletes the specified Service Account secret. + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountSecret. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt index d815789064..0dd00fc3e1 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt @@ -12,10 +12,12 @@ atlas api serviceAccounts deleteServiceAccount :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Deletes the specified Service Account.Deletes the specified Service Account. + 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. -Deletes the specified Service Account. + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt index 88b4d9f99d..6a332bef88 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt @@ -12,10 +12,12 @@ 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.Removes the specified access list entry from the specified Service Account for the organization. + 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. -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 074602d1f4..28874e6ca7 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt @@ -12,10 +12,12 @@ atlas api serviceAccounts deleteServiceAccountSecret :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Deletes the specified Service Account secret.Deletes the specified Service Account secret. + 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. -Deletes the specified Service Account secret. + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountSecret. diff --git a/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt index b0f8cf962d..9bde7542ff 100644 --- a/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt @@ -12,10 +12,12 @@ atlas api serviceAccounts getProjectServiceAccount :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one Service Account in the specified Project.Returns one Service Account in the specified Project. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getProjectServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt index e2a1cd2808..d738b03e16 100644 --- a/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt @@ -12,10 +12,12 @@ atlas api serviceAccounts getServiceAccount :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the specified Service Account.Returns the specified Service Account. + 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. -Returns the specified Service Account. + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt index 77c4aec4a2..d2aba8892a 100644 --- a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt @@ -12,10 +12,12 @@ 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.Returns all access list entries that you configured for the specified Service Account for the project. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccountAccessList. diff --git a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt index dff5084a81..d35d8f71ae 100644 --- a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt @@ -12,10 +12,12 @@ atlas api serviceAccounts listProjectServiceAccounts :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all Service Accounts for the specified Project.Returns all Service Accounts for the specified Project. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccounts. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt index 6f587c348c..746ca07e74 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt @@ -12,10 +12,12 @@ 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.Returns all access list entries that you configured for the specified Service Account for the organization. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountAccessList. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt index 17beeaf482..b7ab5a64df 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt @@ -12,10 +12,12 @@ 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.Returns a list of all projects the specified Service Account is a part of. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountProjects. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt index 038ceb42a9..a6bdefdca4 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt @@ -12,10 +12,12 @@ atlas api serviceAccounts listServiceAccounts :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all Service Accounts for the specified Organization.Returns all Service Accounts for the specified Organization. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccounts. diff --git a/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt index 26b183f459..7e5ea806c2 100644 --- a/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt @@ -12,10 +12,12 @@ atlas api serviceAccounts updateProjectServiceAccount :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates one Service Account in the specified Project.Updates one Service Account in the specified Project. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateProjectServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt index 8fd0189e77..9b7c583f50 100644 --- a/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt @@ -12,10 +12,12 @@ atlas api serviceAccounts updateServiceAccount :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates the specified Service Account in the specified Organization.Updates the specified Service Account in the specified Organization. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateServiceAccount. diff --git a/docs/command/atlas-api-serviceAccounts.txt b/docs/command/atlas-api-serviceAccounts.txt index e8ffb46a00..c8259f2539 100644 --- a/docs/command/atlas-api-serviceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts.txt @@ -12,10 +12,12 @@ atlas api serviceAccounts :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Endpoints for managing Service Accounts and secrets.Endpoints for managing Service Accounts and secrets. + 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. -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,94 +56,28 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serviceAccounts-addProjectServiceAccount` - 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. - -Assigns the specified Service Account to the specified Project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccount` - 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. - -Creates one Service Account for the specified Project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountAccessList` - 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. - -Add Access List Entries for the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountSecret` - 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. - -Create a secret for the specified Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-createServiceAccount` - 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. - -Creates one Service Account for the specified Organization. -* :ref:`atlas-api-serviceAccounts-createServiceAccountAccessList` - 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. - -Add Access List Entries for the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-createServiceAccountSecret` - 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. - -Create a secret for the specified Service Account. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccount` - 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. - -Removes the specified Service Account from the specified project. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry` - 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. - -Removes the specified access list entry from the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountSecret` - 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. - -Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccount` - 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. - -Deletes the specified Service Account. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry` - 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. - -Removes the specified access list entry from the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccountSecret` - 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. - -Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-getProjectServiceAccount` - 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. - -Returns one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-getServiceAccount` - 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. - -Returns the specified Service Account. -* :ref:`atlas-api-serviceAccounts-listProjectServiceAccountAccessList` - 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. - -Returns all access list entries that you configured for the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-listProjectServiceAccounts` - 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. - -Returns all Service Accounts for the specified Project. -* :ref:`atlas-api-serviceAccounts-listServiceAccountAccessList` - 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. - -Returns all access list entries that you configured for the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-listServiceAccountProjects` - 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. - -Returns a list of all projects the specified Service Account is a part of. -* :ref:`atlas-api-serviceAccounts-listServiceAccounts` - 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. - -Returns all Service Accounts for the specified Organization. -* :ref:`atlas-api-serviceAccounts-updateProjectServiceAccount` - 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. - -Updates one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-updateServiceAccount` - 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. - -Updates the specified Service Account in the specified Organization. +* :ref:`atlas-api-serviceAccounts-addProjectServiceAccount` - `Public Preview: please provide feedback `_: Assigns the specified Service Account to the specified Project.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.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.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.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.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.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.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.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.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.Deletes the specified Service Account secret. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccount` - `Public Preview: please provide feedback `_: Deletes the specified Service Account.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.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.Deletes the specified Service Account secret. +* :ref:`atlas-api-serviceAccounts-getProjectServiceAccount` - `Public Preview: please provide feedback `_: Returns one Service Account in the specified Project.Returns one Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-getServiceAccount` - `Public Preview: please provide feedback `_: Returns the specified Service Account.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.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.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.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.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.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.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.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 e2e08475a6..ff980f5753 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt @@ -12,10 +12,12 @@ atlas api sharedTierRestoreJobs createSharedClusterBackupRestoreJob :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Restores the specified M2 or M5 cluster.Restores the specified M2 or M5 cluster. + 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. -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 424683fe7d..1caa2c4f14 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt @@ -12,10 +12,12 @@ 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.Returns the specified restore job for the specified M2 or M5 cluster. + 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. -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 5f3377d8a6..b52e443069 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt @@ -12,10 +12,12 @@ atlas api sharedTierRestoreJobs listSharedClusterBackupRestoreJobs :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all restore jobs for the specified M2 or M5 cluster.Returns all restore jobs for the specified M2 or M5 cluster. + 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. -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 0b043be59d..3142bb896c 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs.txt @@ -12,10 +12,14 @@ atlas api sharedTierRestoreJobs :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns and adds restore jobs for shared-tier database deployments.Returns and adds restore jobs for shared-tier database deployments. + 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. -Returns and adds restore jobs for shared-tier database deployments. + + + Options ------- @@ -52,18 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob` - 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. - -Restores the specified M2 or M5 cluster. -* :ref:`atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob` - 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. - -Returns the specified restore job for the specified M2 or M5 cluster. -* :ref:`atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs` - 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. - -Returns all restore jobs for the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores the specified M2 or M5 cluster.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.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.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 d93e1020df..92ebaea167 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt @@ -12,10 +12,12 @@ atlas api sharedTierSnapshots downloadSharedClusterBackup :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Requests one snapshot for the specified shared cluster.Requests one snapshot for the specified shared cluster. + 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. -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 1807cff454..8c2c8c86b7 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt @@ -12,10 +12,12 @@ atlas api sharedTierSnapshots getSharedClusterBackup :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns details for one snapshot for the specified shared cluster.Returns details for one snapshot for the specified shared cluster. + 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. -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 18551cffe7..964dcb9c9d 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt @@ -12,10 +12,12 @@ atlas api sharedTierSnapshots listSharedClusterBackups :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns details for all snapshots for the specified shared cluster.Returns details for all snapshots for the specified shared cluster. + 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. -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 977d1c6447..707d561618 100644 --- a/docs/command/atlas-api-sharedTierSnapshots.txt +++ b/docs/command/atlas-api-sharedTierSnapshots.txt @@ -12,10 +12,14 @@ atlas api sharedTierSnapshots :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns and requests to download shared-tier database deployment snapshots.Returns and requests to download shared-tier database deployment snapshots. + 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. -Returns and requests to download shared-tier database deployment snapshots. + + + Options ------- @@ -52,18 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierSnapshots-downloadSharedClusterBackup` - 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. - -Requests one snapshot for the specified shared cluster. -* :ref:`atlas-api-sharedTierSnapshots-getSharedClusterBackup` - 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. - -Returns details for one snapshot for the specified shared cluster. -* :ref:`atlas-api-sharedTierSnapshots-listSharedClusterBackups` - 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. - -Returns details for all snapshots for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-downloadSharedClusterBackup` - `Public Preview: please provide feedback `_: Requests one snapshot for the specified shared cluster.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.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.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 cea09b1d75..2c592581f2 100644 --- a/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt @@ -12,10 +12,12 @@ atlas api streams acceptVpcPeeringConnection :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Requests the acceptance of an incoming VPC Peering connection.Requests the acceptance of an incoming VPC Peering connection. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/acceptVpcPeeringConnection. diff --git a/docs/command/atlas-api-streams-createPrivateLinkConnection.txt b/docs/command/atlas-api-streams-createPrivateLinkConnection.txt index 5123f8764d..56fae7192f 100644 --- a/docs/command/atlas-api-streams-createPrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-createPrivateLinkConnection.txt @@ -12,10 +12,12 @@ atlas api streams createPrivateLinkConnection :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one Private Link in the specified project.Creates one Private Link in the specified project. + 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. -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 8423e91f12..56bd5616ac 100644 --- a/docs/command/atlas-api-streams-createStreamConnection.txt +++ b/docs/command/atlas-api-streams-createStreamConnection.txt @@ -12,10 +12,12 @@ atlas api streams createStreamConnection :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one connection for a stream instance in the specified project.Creates one connection for a stream instance in the specified project. + 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. -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 f683b43bc4..ce51275050 100644 --- a/docs/command/atlas-api-streams-createStreamInstance.txt +++ b/docs/command/atlas-api-streams-createStreamInstance.txt @@ -12,10 +12,12 @@ atlas api streams createStreamInstance :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one stream instance in the specified project.Creates one stream instance in the specified project. + 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. -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 0fe0d85a15..05cf62cafe 100644 --- a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt +++ b/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt @@ -12,10 +12,12 @@ atlas api streams createStreamInstanceWithSampleConnections :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one stream instance in the specified project with sample connections.Creates one stream instance in the specified project with sample connections. + 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. -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 0059471f22..a2752f2e7e 100644 --- a/docs/command/atlas-api-streams-createStreamProcessor.txt +++ b/docs/command/atlas-api-streams-createStreamProcessor.txt @@ -12,10 +12,12 @@ atlas api streams createStreamProcessor :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Create one Stream Processor within the specified stream instance.Create one Stream Processor within the specified stream instance. + 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. -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 1185d97ab2..78b92ce35b 100644 --- a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt @@ -12,10 +12,12 @@ atlas api streams deletePrivateLinkConnection :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Deletes one Private Link in the specified project.Deletes one Private Link in the specified project. + 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. -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 5493fd392e..cf7fc49e53 100644 --- a/docs/command/atlas-api-streams-deleteStreamConnection.txt +++ b/docs/command/atlas-api-streams-deleteStreamConnection.txt @@ -12,10 +12,12 @@ atlas api streams deleteStreamConnection :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Delete one connection of the specified stream instance.Delete one connection of the specified stream instance. + 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. -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 abea30cfc6..c7ee48dbdd 100644 --- a/docs/command/atlas-api-streams-deleteStreamInstance.txt +++ b/docs/command/atlas-api-streams-deleteStreamInstance.txt @@ -12,10 +12,12 @@ atlas api streams deleteStreamInstance :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Delete one stream instance in the specified project.Delete one stream instance in the specified project. + 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. -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 0d4ae31771..08154b3c17 100644 --- a/docs/command/atlas-api-streams-deleteStreamProcessor.txt +++ b/docs/command/atlas-api-streams-deleteStreamProcessor.txt @@ -12,10 +12,12 @@ atlas api streams deleteStreamProcessor :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Delete a Stream Processor within the specified stream instance.Delete a Stream Processor within the specified stream instance. + 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. -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 cde2890556..7c7e560177 100644 --- a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt @@ -12,10 +12,12 @@ atlas api streams deleteVpcPeeringConnection :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Deletes an incoming VPC Peering connection.Deletes an incoming VPC Peering connection. + 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. -Deletes an incoming VPC Peering connection. + This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteVpcPeeringConnection. diff --git a/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt b/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt index 5eec8f71c2..58486e4f9f 100644 --- a/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt +++ b/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt @@ -12,10 +12,12 @@ atlas api streams downloadStreamTenantAuditLogs :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Downloads the audit logs for the specified Atlas Streams Processing instance.Downloads the audit logs for the specified Atlas Streams Processing instance. + 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. -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 31f8c185ba..d80fd71598 100644 --- a/docs/command/atlas-api-streams-getAccountDetails.txt +++ b/docs/command/atlas-api-streams-getAccountDetails.txt @@ -12,10 +12,12 @@ 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.Returns the Account ID, and the VPC ID for the group and region specified. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getAccountDetails. diff --git a/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt index d452ea41c5..b401144b48 100644 --- a/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt +++ b/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt @@ -12,10 +12,12 @@ atlas api streams getActiveVpcPeeringConnections :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns a list of active incoming VPC Peering Connections.Returns a list of active incoming VPC Peering Connections. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getActiveVpcPeeringConnections. diff --git a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt index aff69bd2e3..17bedc988a 100644 --- a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt @@ -12,10 +12,12 @@ atlas api streams getPrivateLinkConnection :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the details of one Private Link connection within the project.Returns the details of one Private Link connection within the project. + 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. -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 b3e9a2c342..9f5a85d85c 100644 --- a/docs/command/atlas-api-streams-getStreamConnection.txt +++ b/docs/command/atlas-api-streams-getStreamConnection.txt @@ -12,10 +12,12 @@ 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.Returns the details of one stream connection within the specified stream instance. + 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. -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 e68327ff87..e444bf937b 100644 --- a/docs/command/atlas-api-streams-getStreamInstance.txt +++ b/docs/command/atlas-api-streams-getStreamInstance.txt @@ -12,10 +12,12 @@ atlas api streams getStreamInstance :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the details of one stream instance within the specified project.Returns the details of one stream instance within the specified project. + 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. -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 79fd275389..3131272758 100644 --- a/docs/command/atlas-api-streams-getStreamProcessor.txt +++ b/docs/command/atlas-api-streams-getStreamProcessor.txt @@ -12,10 +12,12 @@ atlas api streams getStreamProcessor :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Get one Stream Processor within the specified stream instance.Get one Stream Processor within the specified stream instance. + 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. -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 a61eb5b5a3..6ef7494fdc 100644 --- a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt +++ b/docs/command/atlas-api-streams-getVpcPeeringConnections.txt @@ -12,10 +12,12 @@ atlas api streams getVpcPeeringConnections :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns a list of incoming VPC Peering Connections.Returns a list of incoming VPC Peering Connections. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getVpcPeeringConnections. diff --git a/docs/command/atlas-api-streams-listPrivateLinkConnections.txt b/docs/command/atlas-api-streams-listPrivateLinkConnections.txt index a82ac2dbcf..6a0441ee85 100644 --- a/docs/command/atlas-api-streams-listPrivateLinkConnections.txt +++ b/docs/command/atlas-api-streams-listPrivateLinkConnections.txt @@ -12,10 +12,12 @@ atlas api streams listPrivateLinkConnections :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all Private Link connections for the specified project.Returns all Private Link connections for the specified project. + 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. -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 136fbd7e18..a90b1a0188 100644 --- a/docs/command/atlas-api-streams-listStreamConnections.txt +++ b/docs/command/atlas-api-streams-listStreamConnections.txt @@ -12,10 +12,12 @@ atlas api streams listStreamConnections :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all connections of the stream instance for the specified project.Returns all connections of the stream instance for the specified project. + 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. -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 39ad3cb5cf..bb25fa4b19 100644 --- a/docs/command/atlas-api-streams-listStreamInstances.txt +++ b/docs/command/atlas-api-streams-listStreamInstances.txt @@ -12,10 +12,12 @@ atlas api streams listStreamInstances :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all stream instances for the specified project.Returns all stream instances for the specified project. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamInstances. diff --git a/docs/command/atlas-api-streams-listStreamProcessors.txt b/docs/command/atlas-api-streams-listStreamProcessors.txt index b0873096c8..cfca48ffc9 100644 --- a/docs/command/atlas-api-streams-listStreamProcessors.txt +++ b/docs/command/atlas-api-streams-listStreamProcessors.txt @@ -12,10 +12,12 @@ atlas api streams listStreamProcessors :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all Stream Processors within the specified stream instance.Returns all Stream Processors within the specified stream instance. + 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. -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 bdfad90c5b..d1970567f7 100644 --- a/docs/command/atlas-api-streams-modifyStreamProcessor.txt +++ b/docs/command/atlas-api-streams-modifyStreamProcessor.txt @@ -12,10 +12,12 @@ atlas api streams modifyStreamProcessor :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Modify one existing Stream Processor within the specified stream instance.Modify one existing Stream Processor within the specified stream instance. + 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. -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 de635dddb0..63eea30e2c 100644 --- a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt @@ -12,10 +12,12 @@ atlas api streams rejectVpcPeeringConnection :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Requests the rejection of an incoming VPC Peering connection.Requests the rejection of an incoming VPC Peering connection. + 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. -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/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/rejectVpcPeeringConnection. diff --git a/docs/command/atlas-api-streams-startStreamProcessor.txt b/docs/command/atlas-api-streams-startStreamProcessor.txt index 839cbc51c8..db8a784257 100644 --- a/docs/command/atlas-api-streams-startStreamProcessor.txt +++ b/docs/command/atlas-api-streams-startStreamProcessor.txt @@ -12,10 +12,12 @@ atlas api streams startStreamProcessor :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Start a Stream Processor within the specified stream instance.Start a Stream Processor within the specified stream instance. + 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. -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 e0832e15a5..461949583c 100644 --- a/docs/command/atlas-api-streams-startStreamProcessorWith.txt +++ b/docs/command/atlas-api-streams-startStreamProcessorWith.txt @@ -12,10 +12,12 @@ atlas api streams startStreamProcessorWith :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Start a Stream Processor within the specified stream instance.Start a Stream Processor within the specified stream instance. + 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. -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 49dc7bc120..89fde8120f 100644 --- a/docs/command/atlas-api-streams-stopStreamProcessor.txt +++ b/docs/command/atlas-api-streams-stopStreamProcessor.txt @@ -12,10 +12,12 @@ atlas api streams stopStreamProcessor :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Stop a Stream Processor within the specified stream instance.Stop a Stream Processor within the specified stream instance. + 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. -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 8944074673..fa7a9386cb 100644 --- a/docs/command/atlas-api-streams-updateStreamConnection.txt +++ b/docs/command/atlas-api-streams-updateStreamConnection.txt @@ -12,10 +12,12 @@ 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.Update one connection for the specified stream instance in the specified project. + 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. -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 d7326e23da..92114dfa55 100644 --- a/docs/command/atlas-api-streams-updateStreamInstance.txt +++ b/docs/command/atlas-api-streams-updateStreamInstance.txt @@ -12,10 +12,12 @@ atlas api streams updateStreamInstance :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Update one stream instance in the specified project.Update one stream instance in the specified project. + 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. -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 d5c2197426..d99c0742a8 100644 --- a/docs/command/atlas-api-streams.txt +++ b/docs/command/atlas-api-streams.txt @@ -12,10 +12,12 @@ atlas api streams :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes Streams Instances.Returns, adds, edits, and removes Streams Instances. + 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. -Returns, adds, edits, and removes Streams Instances. + This resource requires your project ID. @@ -54,126 +56,36 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-streams-acceptVpcPeeringConnection` - 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. - -Requests the acceptance of an incoming VPC Peering connection. -* :ref:`atlas-api-streams-createPrivateLinkConnection` - 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. - -Creates one Private Link in the specified project. -* :ref:`atlas-api-streams-createStreamConnection` - 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. - -Creates one connection for a stream instance in the specified project. -* :ref:`atlas-api-streams-createStreamInstance` - 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. - -Creates one stream instance in the specified project. -* :ref:`atlas-api-streams-createStreamInstanceWithSampleConnections` - 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. - -Creates one stream instance in the specified project with sample connections. -* :ref:`atlas-api-streams-createStreamProcessor` - 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. - -Create one Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-deletePrivateLinkConnection` - 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. - -Deletes one Private Link in the specified project. -* :ref:`atlas-api-streams-deleteStreamConnection` - 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. - -Delete one connection of the specified stream instance. -* :ref:`atlas-api-streams-deleteStreamInstance` - 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. - -Delete one stream instance in the specified project. -* :ref:`atlas-api-streams-deleteStreamProcessor` - 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. - -Delete a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-deleteVpcPeeringConnection` - 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. - -Deletes an incoming VPC Peering connection. -* :ref:`atlas-api-streams-downloadStreamTenantAuditLogs` - 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. - -Downloads the audit logs for the specified Atlas Streams Processing instance. -* :ref:`atlas-api-streams-getAccountDetails` - 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. - -Returns the Account ID, and the VPC ID for the group and region specified. -* :ref:`atlas-api-streams-getActiveVpcPeeringConnections` - 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. - -Returns a list of active incoming VPC Peering Connections. -* :ref:`atlas-api-streams-getPrivateLinkConnection` - 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. - -Returns the details of one Private Link connection within the project. -* :ref:`atlas-api-streams-getStreamConnection` - 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. - -Returns the details of one stream connection within the specified stream instance. -* :ref:`atlas-api-streams-getStreamInstance` - 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. - -Returns the details of one stream instance within the specified project. -* :ref:`atlas-api-streams-getStreamProcessor` - 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. - -Get one Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-getVpcPeeringConnections` - 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. - -Returns a list of incoming VPC Peering Connections. -* :ref:`atlas-api-streams-listPrivateLinkConnections` - 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. - -Returns all Private Link connections for the specified project. -* :ref:`atlas-api-streams-listStreamConnections` - 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. - -Returns all connections of the stream instance for the specified project. -* :ref:`atlas-api-streams-listStreamInstances` - 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. - -Returns all stream instances for the specified project. -* :ref:`atlas-api-streams-listStreamProcessors` - 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. - -Returns all Stream Processors within the specified stream instance. -* :ref:`atlas-api-streams-modifyStreamProcessor` - 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. - -Modify one existing Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-rejectVpcPeeringConnection` - 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. - -Requests the rejection of an incoming VPC Peering connection. -* :ref:`atlas-api-streams-startStreamProcessor` - 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. - -Start a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-startStreamProcessorWith` - 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. - -Start a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-stopStreamProcessor` - 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. - -Stop a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-updateStreamConnection` - 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. - -Update one connection for the specified stream instance in the specified project. -* :ref:`atlas-api-streams-updateStreamInstance` - 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. - -Update one stream instance in the specified project. +* :ref:`atlas-api-streams-acceptVpcPeeringConnection` - `Public Preview: please provide feedback `_: Requests the acceptance of an incoming VPC Peering connection.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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 98a43935df..8ea471065d 100644 --- a/docs/command/atlas-api-teams-addAllTeamsToProject.txt +++ b/docs/command/atlas-api-teams-addAllTeamsToProject.txt @@ -12,10 +12,12 @@ atlas api teams addAllTeamsToProject :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Adds one or more teams to the specified project.Adds one or more teams to the specified project. + 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. -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 8ed4205af6..d1a7fb38c3 100644 --- a/docs/command/atlas-api-teams-addTeamUser.txt +++ b/docs/command/atlas-api-teams-addTeamUser.txt @@ -12,10 +12,12 @@ 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.Adds one or more MongoDB Cloud users from the specified organization to the specified team. + 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. -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 fbd4066368..55a8117b6e 100644 --- a/docs/command/atlas-api-teams-createTeam.txt +++ b/docs/command/atlas-api-teams-createTeam.txt @@ -12,10 +12,12 @@ atlas api teams createTeam :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Creates one team in the specified organization.Creates one team in the specified organization. + 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. -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 ac40075a87..319029e77f 100644 --- a/docs/command/atlas-api-teams-deleteTeam.txt +++ b/docs/command/atlas-api-teams-deleteTeam.txt @@ -12,10 +12,12 @@ 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.Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. + 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. -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-getTeamById.txt b/docs/command/atlas-api-teams-getTeamById.txt index 1881f71273..ae731aef97 100644 --- a/docs/command/atlas-api-teams-getTeamById.txt +++ b/docs/command/atlas-api-teams-getTeamById.txt @@ -12,10 +12,12 @@ 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.Returns one team that you identified using its unique 24-hexadecimal digit ID. + 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. -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 c447e2a24b..6383aaaac6 100644 --- a/docs/command/atlas-api-teams-getTeamByName.txt +++ b/docs/command/atlas-api-teams-getTeamByName.txt @@ -12,10 +12,12 @@ atlas api teams getTeamByName :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns one team that you identified using its human-readable name.Returns one team that you identified using its human-readable name. + 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. -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 7f3f1658e5..67d6514991 100644 --- a/docs/command/atlas-api-teams-listOrganizationTeams.txt +++ b/docs/command/atlas-api-teams-listOrganizationTeams.txt @@ -12,10 +12,12 @@ atlas api teams listOrganizationTeams :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all teams that belong to the specified organization.Returns all teams that belong to the specified organization. + 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. -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 ab9cbb9580..a13f36f225 100644 --- a/docs/command/atlas-api-teams-listProjectTeams.txt +++ b/docs/command/atlas-api-teams-listProjectTeams.txt @@ -12,10 +12,12 @@ 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.Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. + 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. -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 d1dd06c89b..5d4c8ebdec 100644 --- a/docs/command/atlas-api-teams-removeProjectTeam.txt +++ b/docs/command/atlas-api-teams-removeProjectTeam.txt @@ -12,10 +12,12 @@ 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.Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. + 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. -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 169739bebf..d544dcb889 100644 --- a/docs/command/atlas-api-teams-removeTeamUser.txt +++ b/docs/command/atlas-api-teams-removeTeamUser.txt @@ -12,10 +12,12 @@ atlas api teams removeTeamUser :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from the specified team.Removes one MongoDB Cloud user from the specified team. + 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. -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 d7ca588138..17852dec3b 100644 --- a/docs/command/atlas-api-teams-renameTeam.txt +++ b/docs/command/atlas-api-teams-renameTeam.txt @@ -12,10 +12,12 @@ atlas api teams renameTeam :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Renames one team in the specified organization.Renames one team in the specified organization. + 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. -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 5a8e281679..d1f2fed5b2 100644 --- a/docs/command/atlas-api-teams-updateTeamRoles.txt +++ b/docs/command/atlas-api-teams-updateTeamRoles.txt @@ -12,10 +12,12 @@ atlas api teams updateTeamRoles :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates the project roles assigned to the specified team.Updates the project roles assigned to the specified team. + 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. -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 5cf55cee39..d1b8b81186 100644 --- a/docs/command/atlas-api-teams.txt +++ b/docs/command/atlas-api-teams.txt @@ -12,10 +12,14 @@ atlas api teams :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, edits, or removes teams.Returns, adds, edits, or removes teams. + 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. -Returns, adds, edits, or removes teams. + + + Options ------- @@ -52,54 +56,18 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-teams-addAllTeamsToProject` - 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. - -Adds one or more teams to the specified project. -* :ref:`atlas-api-teams-addTeamUser` - 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. - -Adds one or more MongoDB Cloud users from the specified organization to the specified team. -* :ref:`atlas-api-teams-createTeam` - 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. - -Creates one team in the specified organization. -* :ref:`atlas-api-teams-deleteTeam` - 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. - -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-getTeamById` - 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. - -Returns one team that you identified using its unique 24-hexadecimal digit ID. -* :ref:`atlas-api-teams-getTeamByName` - 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. - -Returns one team that you identified using its human-readable name. -* :ref:`atlas-api-teams-listOrganizationTeams` - 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. - -Returns all teams that belong to the specified organization. -* :ref:`atlas-api-teams-listProjectTeams` - 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. - -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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. -* :ref:`atlas-api-teams-removeTeamUser` - 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. - -Removes one MongoDB Cloud user from the specified team. -* :ref:`atlas-api-teams-renameTeam` - 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. - -Renames one team in the specified organization. -* :ref:`atlas-api-teams-updateTeamRoles` - 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. - -Updates the project roles assigned to the specified team. +* :ref:`atlas-api-teams-addAllTeamsToProject` - `Public Preview: please provide feedback `_: Adds one or more teams to the specified project.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.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.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.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-getTeamById` - `Public Preview: please provide feedback `_: Returns one team that you identified using its unique 24-hexadecimal digit ID.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.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.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.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.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.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.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.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 7ec37190f7..f68fbb919a 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt @@ -12,10 +12,12 @@ atlas api thirdPartyIntegrations createThirdPartyIntegration :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Adds the settings for configuring one third-party service integration.Adds the settings for configuring one third-party service integration. + 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. -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 a1e6649041..89b7265015 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt @@ -12,10 +12,12 @@ atlas api thirdPartyIntegrations deleteThirdPartyIntegration :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Removes the settings that permit configuring one third-party service integration.Removes the settings that permit configuring one third-party service integration. + 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. -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 22cb044ada..f344afe688 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt @@ -12,10 +12,12 @@ atlas api thirdPartyIntegrations getThirdPartyIntegration :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns the settings for configuring integration with one third-party service.Returns the settings for configuring integration with one third-party service. + 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. -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 acdfda7e9e..a013722401 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt @@ -12,10 +12,12 @@ 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.Returns the settings that permit integrations with all configured third-party services. + 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. -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 1aba874c36..d257ddaae0 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt @@ -12,10 +12,12 @@ atlas api thirdPartyIntegrations updateThirdPartyIntegration :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Updates the settings for configuring integration with one third-party service.Updates the settings for configuring integration with one third-party service. + 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. -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 d92885f66b..2d893e7b8a 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations.txt @@ -12,10 +12,12 @@ atlas api thirdPartyIntegrations :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes third-party service integration configurations.Returns, adds, edits, and removes third-party service integration configurations. + 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. -Returns, adds, edits, and removes third-party service integration configurations. + MongoDB Cloud sends alerts to each third-party service that you configure. @@ -57,26 +59,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-thirdPartyIntegrations-createThirdPartyIntegration` - 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. - -Adds the settings for configuring one third-party service integration. -* :ref:`atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration` - 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. - -Removes the settings that permit configuring one third-party service integration. -* :ref:`atlas-api-thirdPartyIntegrations-getThirdPartyIntegration` - 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. - -Returns the settings for configuring integration with one third-party service. -* :ref:`atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations` - 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. - -Returns the settings that permit integrations with all configured third-party services. -* :ref:`atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration` - 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. - -Updates the settings for configuring integration with one third-party service. +* :ref:`atlas-api-thirdPartyIntegrations-createThirdPartyIntegration` - `Public Preview: please provide feedback `_: Adds the settings for configuring one third-party service integration.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.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.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.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.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 4bcd2ede50..17c2b44ac7 100644 --- a/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt +++ b/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt @@ -12,10 +12,12 @@ atlas api x509Authentication createDatabaseUserCertificate :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Generates one X.509 certificate for the specified MongoDB user.Generates one X.509 certificate for the specified MongoDB user. + 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. -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 4fa4faa8d5..5ddb566ca2 100644 --- a/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt +++ b/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt @@ -12,10 +12,12 @@ 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.Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. + 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. -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 7671f55af7..bf9be268a1 100644 --- a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt +++ b/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt @@ -12,10 +12,12 @@ atlas api x509Authentication listDatabaseUserCertificates :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns all unexpired X.509 certificates for the specified MongoDB user.Returns all unexpired X.509 certificates for the specified MongoDB user. + 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. -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 693c2fd3bb..fc03634f39 100644 --- a/docs/command/atlas-api-x509Authentication.txt +++ b/docs/command/atlas-api-x509Authentication.txt @@ -12,10 +12,12 @@ atlas api x509Authentication :depth: 1 :class: singlecol +`Public Preview: please provide feedback `_: Returns, edits, and removes user-managed X.509 configurations.Returns, edits, and removes user-managed X.509 configurations. + 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. -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,18 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-x509Authentication-createDatabaseUserCertificate` - 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. - -Generates one X.509 certificate for the specified MongoDB user. -* :ref:`atlas-api-x509Authentication-disableCustomerManagedX509` - 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. - -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: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.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. +* :ref:`atlas-api-x509Authentication-createDatabaseUserCertificate` - `Public Preview: please provide feedback `_: Generates one X.509 certificate for the specified MongoDB user.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.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.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 63a60454ac..2dc9699342 100644 --- a/docs/command/atlas-api.txt +++ b/docs/command/atlas-api.txt @@ -14,6 +14,11 @@ atlas api Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '. +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. + + + This feature in public preview streamlines script development by letting you interact directly with any Atlas Administration API endpoint by using the Atlas CLI. For more information on @@ -174,206 +179,56 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-accessTracking` - 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. - -Returns access logs for authentication attempts made to Atlas database deployments. -* :ref:`atlas-api-alertConfigurations` - 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. - -Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. -* :ref:`atlas-api-alerts` - 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. - -Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. -* :ref:`atlas-api-atlasSearch` - 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. - -Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. -* :ref:`atlas-api-auditing` - 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. - -Returns and edits database auditing settings for MongoDB Cloud projects. -* :ref:`atlas-api-awsClustersDns` - 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. - -Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. -* :ref:`atlas-api-cloudBackups` - 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. - -Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. -* :ref:`atlas-api-cloudMigrationService` - 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. - -Manages the Cloud Migration Service. -* :ref:`atlas-api-cloudProviderAccess` - 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. - -Returns, adds, authorizes, and removes AWS IAM roles in Atlas. -* :ref:`atlas-api-clusterOutageSimulation` - 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. - -Returns, starts, or ends a cluster outage simulation. -* :ref:`atlas-api-clusters` - 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. - -Returns, adds, edits, and removes database deployments. -* :ref:`atlas-api-collectionLevelMetrics` - 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. - -Returns, adds, and edits pinned namespaces for the specified cluster or process. -* :ref:`atlas-api-customDatabaseRoles` - 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. - -Returns, adds, edits, and removes custom database user privilege roles. -* :ref:`atlas-api-dataFederation` - 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. - -Returns, adds, edits, and removes Federated Database Instances. -* :ref:`atlas-api-dataLakePipelines` - 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. - -Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. -* :ref:`atlas-api-databaseUsers` - 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. - -Returns, adds, edits, and removes database users. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement` - 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. - -Returns and edits the Encryption at Rest using Customer Key Management configuration. -* :ref:`atlas-api-events` - 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. - -Returns events. -* :ref:`atlas-api-federatedAuthentication` - 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. - -Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. -* :ref:`atlas-api-flexClusters` - 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. - -Returns, adds, edits, and removes flex clusters. -* :ref:`atlas-api-flexRestoreJobs` - 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. - -Returns and adds restore jobs for flex database deployments. -* :ref:`atlas-api-flexSnapshots` - 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. - -Returns and requests to download flex database deployment snapshots. -* :ref:`atlas-api-globalClusters` - 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. - -Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. -* :ref:`atlas-api-invoices` - 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. - -Returns invoices. -* :ref:`atlas-api-ldapConfiguration` - 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. - -Returns, edits, verifies, and removes LDAP configurations. -* :ref:`atlas-api-legacyBackup` - 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. - -Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. -* :ref:`atlas-api-maintenanceWindows` - 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. - -Returns, edits, and removes maintenance windows. -* :ref:`atlas-api-mongoDbCloudUsers` - 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. - -Returns, adds, and edits MongoDB Cloud users. -* :ref:`atlas-api-monitoringAndLogs` - 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. - -Returns database deployment monitoring and logging data. -* :ref:`atlas-api-networkPeering` - 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. - -Returns, adds, edits, and removes network peering containers and peering connections. -* :ref:`atlas-api-onlineArchive` - 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. - -Returns, adds, edits, or removes an online archive. -* :ref:`atlas-api-organizations` - 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. - -Returns, adds, and edits organizational units in MongoDB Cloud. -* :ref:`atlas-api-performanceAdvisor` - 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. - -Returns suggested indexes and slow query data for a database deployment. -* :ref:`atlas-api-privateEndpointServices` - 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. - -Returns, adds, edits, and removes private endpoint services. -* :ref:`atlas-api-programmaticApiKeys` - 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. - -Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. -* :ref:`atlas-api-projectIpAccessList` - 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. - -Returns, adds, edits, and removes network access limits to database deployments in Atlas. -* :ref:`atlas-api-projects` - 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. - -Returns, adds, and edits collections of clusters and users in MongoDB Cloud. -* :ref:`atlas-api-pushBasedLogExport` - 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. - -You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. -* :ref:`atlas-api-resourcePolicies` - 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. - -Configure and manage Atlas Resource Policies within your organization. -* :ref:`atlas-api-rollingIndex` - 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. - -Creates one index to a database deployment in a rolling manner. -* :ref:`atlas-api-root` - 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. - -Returns details that describe the MongoDB Cloud build and the access token that requests this resource. -* :ref:`atlas-api-serverlessInstances` - 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. - -Returns, adds, edits, and removes serverless instances. -* :ref:`atlas-api-serverlessPrivateEndpoints` - 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. - -Returns, adds, edits, and removes private endpoints for serverless instances. -* :ref:`atlas-api-serviceAccounts` - 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. - -Endpoints for managing Service Accounts and secrets. -* :ref:`atlas-api-sharedTierRestoreJobs` - 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. - -Returns and adds restore jobs for shared-tier database deployments. -* :ref:`atlas-api-sharedTierSnapshots` - 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. - -Returns and requests to download shared-tier database deployment snapshots. -* :ref:`atlas-api-streams` - 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. - -Returns, adds, edits, and removes Streams Instances. -* :ref:`atlas-api-teams` - 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. - -Returns, adds, edits, or removes teams. -* :ref:`atlas-api-thirdPartyIntegrations` - 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. - -Returns, adds, edits, and removes third-party service integration configurations. -* :ref:`atlas-api-x509Authentication` - 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. - -Returns, edits, and removes user-managed X.509 configurations. +* :ref:`atlas-api-accessTracking` - `Public Preview: please provide feedback `_: Returns access logs for authentication attempts made to Atlas database deployments.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.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.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.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.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.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.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.Manages the Cloud Migration Service. +* :ref:`atlas-api-cloudProviderAccess` - `Public Preview: please provide feedback `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas.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.Returns, starts, or ends a cluster outage simulation. +* :ref:`atlas-api-clusters` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes database deployments.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.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.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.Returns, adds, edits, and removes Federated Database Instances. +* :ref:`atlas-api-dataLakePipelines` - `Public Preview: please provide feedback `_: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs.Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. +* :ref:`atlas-api-databaseUsers` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes database users.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.Returns and edits the Encryption at Rest using Customer Key Management configuration. +* :ref:`atlas-api-events` - `Public Preview: please provide feedback `_: Returns events.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.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.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.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.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.Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. +* :ref:`atlas-api-invoices` - `Public Preview: please provide feedback `_: Returns invoices.Returns invoices. +* :ref:`atlas-api-ldapConfiguration` - `Public Preview: please provide feedback `_: Returns, edits, verifies, and removes LDAP configurations.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.Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. +* :ref:`atlas-api-maintenanceWindows` - `Public Preview: please provide feedback `_: Returns, edits, and removes maintenance windows.Returns, edits, and removes maintenance windows. +* :ref:`atlas-api-mongoDbCloudUsers` - `Public Preview: please provide feedback `_: Returns, adds, and edits MongoDB Cloud users.Returns, adds, and edits MongoDB Cloud users. +* :ref:`atlas-api-monitoringAndLogs` - `Public Preview: please provide feedback `_: Returns database deployment monitoring and logging data.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.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.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.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.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.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.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.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.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.You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. +* :ref:`atlas-api-resourcePolicies` - `Public Preview: please provide feedback `_: Configure and manage Atlas Resource Policies within your organization.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.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.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.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.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.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.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.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.Returns, adds, edits, and removes Streams Instances. +* :ref:`atlas-api-teams` - `Public Preview: please provide feedback `_: Returns, adds, edits, or removes teams.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.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.Returns, edits, and removes user-managed X.509 configurations. .. toctree:: diff --git a/docs/command/atlas-auditing-describe.txt b/docs/command/atlas-auditing-describe.txt index d5e7d1b59a..62d2c79cba 100644 --- a/docs/command/atlas-auditing-describe.txt +++ b/docs/command/atlas-auditing-describe.txt @@ -14,6 +14,11 @@ atlas auditing describe Returns the auditing configuration for the specified project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-auditing-update.txt b/docs/command/atlas-auditing-update.txt index 9db1566290..8a5fbc5c27 100644 --- a/docs/command/atlas-auditing-update.txt +++ b/docs/command/atlas-auditing-update.txt @@ -14,6 +14,11 @@ atlas auditing update Updates the auditing configuration for the specified project +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-auditing.txt b/docs/command/atlas-auditing.txt index 9a2b9b3290..47fecf31e8 100644 --- a/docs/command/atlas-auditing.txt +++ b/docs/command/atlas-auditing.txt @@ -14,6 +14,13 @@ atlas auditing Returns database auditing settings for MongoDB Cloud projects. +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. + + + + + Options ------- diff --git a/docs/command/atlas-auth-login.txt b/docs/command/atlas-auth-login.txt index 689d867fa7..3076bc3039 100644 --- a/docs/command/atlas-auth-login.txt +++ b/docs/command/atlas-auth-login.txt @@ -14,6 +14,13 @@ atlas auth login Authenticate with MongoDB Atlas. +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/docs/command/atlas-auth-logout.txt b/docs/command/atlas-auth-logout.txt index 26bae6e33e..279b985afd 100644 --- a/docs/command/atlas-auth-logout.txt +++ b/docs/command/atlas-auth-logout.txt @@ -14,6 +14,13 @@ atlas auth logout Log out of the CLI. +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/docs/command/atlas-auth-register.txt b/docs/command/atlas-auth-register.txt index e61b24277b..10685a269b 100644 --- a/docs/command/atlas-auth-register.txt +++ b/docs/command/atlas-auth-register.txt @@ -14,6 +14,13 @@ atlas auth register Register with MongoDB Atlas. +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/docs/command/atlas-auth-whoami.txt b/docs/command/atlas-auth-whoami.txt index 35aabc095e..69303e5542 100644 --- a/docs/command/atlas-auth-whoami.txt +++ b/docs/command/atlas-auth-whoami.txt @@ -14,6 +14,13 @@ atlas auth whoami Verifies and displays information about your authentication state. +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/docs/command/atlas-auth.txt b/docs/command/atlas-auth.txt index eef0de5289..ad0e97c08a 100644 --- a/docs/command/atlas-auth.txt +++ b/docs/command/atlas-auth.txt @@ -14,6 +14,13 @@ atlas auth Manage the CLI's authentication state. +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. + + + + + Options ------- diff --git a/docs/command/atlas-backups-compliancePolicy-copyProtection-disable.txt b/docs/command/atlas-backups-compliancePolicy-copyProtection-disable.txt index 37e4a12583..8d8b80a501 100644 --- a/docs/command/atlas-backups-compliancePolicy-copyProtection-disable.txt +++ b/docs/command/atlas-backups-compliancePolicy-copyProtection-disable.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy copyProtection disable Disable copy protection of the backup compliance policy for your project. +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/docs/command/atlas-backups-compliancePolicy-copyProtection-enable.txt b/docs/command/atlas-backups-compliancePolicy-copyProtection-enable.txt index 3887c8ab05..efd9fbfb60 100644 --- a/docs/command/atlas-backups-compliancePolicy-copyProtection-enable.txt +++ b/docs/command/atlas-backups-compliancePolicy-copyProtection-enable.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy copyProtection enable Enable copy protection of the backup compliance policy for your project. +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/docs/command/atlas-backups-compliancePolicy-copyProtection.txt b/docs/command/atlas-backups-compliancePolicy-copyProtection.txt index 4a57b44306..fa3c107f77 100644 --- a/docs/command/atlas-backups-compliancePolicy-copyProtection.txt +++ b/docs/command/atlas-backups-compliancePolicy-copyProtection.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy copyProtection Manage copy protection of the backup compliance policy for your project. Learn more: https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/#-optional--keep-all-snapshots-when-removing-additional-snapshot-regions. +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. + + + + + Options ------- diff --git a/docs/command/atlas-backups-compliancePolicy-describe.txt b/docs/command/atlas-backups-compliancePolicy-describe.txt index 453824e993..187dab9daf 100644 --- a/docs/command/atlas-backups-compliancePolicy-describe.txt +++ b/docs/command/atlas-backups-compliancePolicy-describe.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy describe Return the backup compliance policy for your project. +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/docs/command/atlas-backups-compliancePolicy-enable.txt b/docs/command/atlas-backups-compliancePolicy-enable.txt index 3050689c0c..b2f47f4806 100644 --- a/docs/command/atlas-backups-compliancePolicy-enable.txt +++ b/docs/command/atlas-backups-compliancePolicy-enable.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy enable Enable Backup Compliance Policy without any configuration. +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/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt b/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt index 5cf0a602be..9123d118e4 100644 --- a/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt +++ b/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy encryptionAtRest disable Disable encryption-at-rest for the backup compliance policy for your project. +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/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt b/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt index ee1b5b3597..c8900d81f6 100644 --- a/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt +++ b/docs/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy encryptionAtRest enable Enable encryption-at-rest for the backup compliance policy for your project. +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/docs/command/atlas-backups-compliancePolicy-encryptionAtRest.txt b/docs/command/atlas-backups-compliancePolicy-encryptionAtRest.txt index 8c4593ff95..9cf4027dce 100644 --- a/docs/command/atlas-backups-compliancePolicy-encryptionAtRest.txt +++ b/docs/command/atlas-backups-compliancePolicy-encryptionAtRest.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy encryptionAtRest Manage encryption-at-rest for the backup compliance policy for your project. Encryption-at-rest enforces all clusters with a Backup Compliance Policy to use Customer Key Management. +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. + + + + + Options ------- diff --git a/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt b/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt index e304ec1e16..39d59bcb53 100644 --- a/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt +++ b/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy pointInTimeRestores enable Enable Point-in-Time restores of the backup compliance policy for your project. +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/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt b/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt index ef796859c2..e8dac4104b 100644 --- a/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt +++ b/docs/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy pointInTimeRestores Manage whether the project uses Continuous Cloud Backups with a Backup Compliance Policy. Read more in the documentation: https://www.mongodb.com/docs/atlas/backup/cloud-backup/configure-backup-policy/#configure-the-restore-window. +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. + + + + + Options ------- diff --git a/docs/command/atlas-backups-compliancePolicy-policies-describe.txt b/docs/command/atlas-backups-compliancePolicy-policies-describe.txt index 67682b6086..7c87c85905 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-describe.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-describe.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies describe Return the individual policy items of the backup compliance policy for your project. +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/docs/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt b/docs/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt index ad02d1aad4..75dfa6dd2f 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies ondemand create Create the on-demand policy item of the backup compliance policy for your project. +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/docs/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt b/docs/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt index 574787f69b..ff3f575607 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies ondemand describe Return the on-demand policy item of the backup compliance policy for your project. +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/docs/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt b/docs/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt index 5380a584ad..0b78d79dcf 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies ondemand update Update the on-demand policy of the backup compliance for your project. +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/docs/command/atlas-backups-compliancePolicy-policies-ondemand.txt b/docs/command/atlas-backups-compliancePolicy-policies-ondemand.txt index 4aad7eae1c..7da30510a7 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-ondemand.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-ondemand.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies ondemand Manage the on-demand policy item of the backup compliance policy for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt b/docs/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt index 302052d88a..bc337f85fd 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies scheduled create Create a scheduled policy item for the backup compliance policy for your project. +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/docs/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt b/docs/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt index f7e60ac25f..2920352a31 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies scheduled describe Return the scheduled policy items of the backup compliance policy for your project. +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/docs/command/atlas-backups-compliancePolicy-policies-scheduled.txt b/docs/command/atlas-backups-compliancePolicy-policies-scheduled.txt index 9d2376fa43..fe54c8e26f 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies-scheduled.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies-scheduled.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies scheduled Manage the scheduled policy items of the backup compliance policy for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-backups-compliancePolicy-policies.txt b/docs/command/atlas-backups-compliancePolicy-policies.txt index 40b7bd48d9..0777a61367 100644 --- a/docs/command/atlas-backups-compliancePolicy-policies.txt +++ b/docs/command/atlas-backups-compliancePolicy-policies.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy policies Manage the individual policy items of the backup compliance policy for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-backups-compliancePolicy-setup.txt b/docs/command/atlas-backups-compliancePolicy-setup.txt index ab2195d9bd..bfeaa88463 100644 --- a/docs/command/atlas-backups-compliancePolicy-setup.txt +++ b/docs/command/atlas-backups-compliancePolicy-setup.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy setup Setup the backup compliance policy for your project with a configuration file. +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/docs/command/atlas-backups-compliancePolicy.txt b/docs/command/atlas-backups-compliancePolicy.txt index b78e1b53db..ca60f97b86 100644 --- a/docs/command/atlas-backups-compliancePolicy.txt +++ b/docs/command/atlas-backups-compliancePolicy.txt @@ -14,6 +14,13 @@ atlas backups compliancePolicy Manage cloud backup compliance policy for your project. Use "atlas backups compliancepolicy setup" to enable backup compliance policy with a full configuration. Use "atlas backups compliancepolicy enable" to enable backup compliance policy without any configuration. +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. + + + + + Options ------- diff --git a/docs/command/atlas-backups-exports-buckets-create.txt b/docs/command/atlas-backups-exports-buckets-create.txt index 484f78bca4..59190cfaa8 100644 --- a/docs/command/atlas-backups-exports-buckets-create.txt +++ b/docs/command/atlas-backups-exports-buckets-create.txt @@ -14,6 +14,11 @@ atlas backups exports buckets create Create an export destination for Atlas backups using an existing AWS S3 bucket. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-backups-exports-buckets-delete.txt b/docs/command/atlas-backups-exports-buckets-delete.txt index 2d46d90e33..8758512636 100644 --- a/docs/command/atlas-backups-exports-buckets-delete.txt +++ b/docs/command/atlas-backups-exports-buckets-delete.txt @@ -14,6 +14,11 @@ atlas backups exports buckets delete Delete a snapshot export bucket. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-backups-exports-buckets-describe.txt b/docs/command/atlas-backups-exports-buckets-describe.txt index 3d32a61e50..b0ff2017eb 100644 --- a/docs/command/atlas-backups-exports-buckets-describe.txt +++ b/docs/command/atlas-backups-exports-buckets-describe.txt @@ -14,6 +14,11 @@ atlas backups exports buckets describe Return one snapshot export bucket. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-backups-exports-buckets-list.txt b/docs/command/atlas-backups-exports-buckets-list.txt index b899715280..16b0e1d303 100644 --- a/docs/command/atlas-backups-exports-buckets-list.txt +++ b/docs/command/atlas-backups-exports-buckets-list.txt @@ -14,6 +14,11 @@ atlas backups exports buckets list List cloud backup restore buckets for your project and cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-backups-exports-buckets.txt b/docs/command/atlas-backups-exports-buckets.txt index c72ae83931..bbbceb9282 100644 --- a/docs/command/atlas-backups-exports-buckets.txt +++ b/docs/command/atlas-backups-exports-buckets.txt @@ -14,6 +14,13 @@ atlas backups exports buckets Manage cloud backup export buckets for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-backups-exports-jobs-create.txt b/docs/command/atlas-backups-exports-jobs-create.txt index 94ce5ccd4e..d025c0f046 100644 --- a/docs/command/atlas-backups-exports-jobs-create.txt +++ b/docs/command/atlas-backups-exports-jobs-create.txt @@ -14,6 +14,11 @@ atlas backups exports jobs create Export one backup snapshot for an M10 or higher Atlas cluster to an existing AWS S3 bucket. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-backups-exports-jobs-describe.txt b/docs/command/atlas-backups-exports-jobs-describe.txt index 01888b547d..aa5ab5319a 100644 --- a/docs/command/atlas-backups-exports-jobs-describe.txt +++ b/docs/command/atlas-backups-exports-jobs-describe.txt @@ -14,6 +14,11 @@ atlas backups exports jobs describe Return one cloud backup export job for your project, cluster and job. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-backups-exports-jobs-list.txt b/docs/command/atlas-backups-exports-jobs-list.txt index 7471289e32..8da9bbacbd 100644 --- a/docs/command/atlas-backups-exports-jobs-list.txt +++ b/docs/command/atlas-backups-exports-jobs-list.txt @@ -14,6 +14,11 @@ atlas backups exports jobs list Return all cloud backup export jobs for your project and cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-backups-exports-jobs-watch.txt b/docs/command/atlas-backups-exports-jobs-watch.txt index c65501c266..317270b0c2 100644 --- a/docs/command/atlas-backups-exports-jobs-watch.txt +++ b/docs/command/atlas-backups-exports-jobs-watch.txt @@ -14,6 +14,11 @@ atlas backups exports jobs watch Watch for the specified export job to complete. +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. + + + This command checks the export job's status periodically until it reaches a completed, cancelled or failed status. Once the export reaches the expected status, the command prints "Export completed." If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. diff --git a/docs/command/atlas-backups-exports-jobs.txt b/docs/command/atlas-backups-exports-jobs.txt index 18641dd17e..15fedcab09 100644 --- a/docs/command/atlas-backups-exports-jobs.txt +++ b/docs/command/atlas-backups-exports-jobs.txt @@ -14,6 +14,13 @@ atlas backups exports jobs Manage cloud backup export jobs for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-backups-exports.txt b/docs/command/atlas-backups-exports.txt index 1038c8c892..8053b20f0d 100644 --- a/docs/command/atlas-backups-exports.txt +++ b/docs/command/atlas-backups-exports.txt @@ -14,6 +14,13 @@ atlas backups exports Manage cloud backup export jobs for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-backups-restores-describe.txt b/docs/command/atlas-backups-restores-describe.txt index b79ffee197..3108c97b8a 100644 --- a/docs/command/atlas-backups-restores-describe.txt +++ b/docs/command/atlas-backups-restores-describe.txt @@ -14,6 +14,11 @@ atlas backups restores describe Describe a cloud backup restore job. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-backups-restores-list.txt b/docs/command/atlas-backups-restores-list.txt index dbbd1f4da7..11a1b79100 100644 --- a/docs/command/atlas-backups-restores-list.txt +++ b/docs/command/atlas-backups-restores-list.txt @@ -14,6 +14,11 @@ atlas backups restores list Return all cloud backup restore jobs for your project and cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-backups-restores-start.txt b/docs/command/atlas-backups-restores-start.txt index 5013a092c7..8879525a70 100644 --- a/docs/command/atlas-backups-restores-start.txt +++ b/docs/command/atlas-backups-restores-start.txt @@ -14,6 +14,11 @@ atlas backups restores start Start a restore job for your project and cluster. +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. + + + If you create an automated or pointInTime restore job, Atlas removes all existing data on the target cluster prior to the restore. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-backups-restores-watch.txt b/docs/command/atlas-backups-restores-watch.txt index c0f540348f..6debf82c71 100644 --- a/docs/command/atlas-backups-restores-watch.txt +++ b/docs/command/atlas-backups-restores-watch.txt @@ -14,6 +14,11 @@ atlas backups restores watch Watch for a restore job to complete. +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. + + + This command checks the restore job's status periodically until it reaches a completed, failed or canceled status. Once the restore reaches the expected status, the command prints "Restore completed." If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. diff --git a/docs/command/atlas-backups-restores.txt b/docs/command/atlas-backups-restores.txt index 5959488c5b..fda2b83f4d 100644 --- a/docs/command/atlas-backups-restores.txt +++ b/docs/command/atlas-backups-restores.txt @@ -14,6 +14,13 @@ atlas backups restores Manage cloud backup restore jobs for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-backups-schedule-delete.txt b/docs/command/atlas-backups-schedule-delete.txt index b78fc1f408..7b9a5ac42a 100644 --- a/docs/command/atlas-backups-schedule-delete.txt +++ b/docs/command/atlas-backups-schedule-delete.txt @@ -14,6 +14,11 @@ atlas backups schedule delete Delete all backup schedules of a cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-backups-schedule-describe.txt b/docs/command/atlas-backups-schedule-describe.txt index bc59d3470b..0853985028 100644 --- a/docs/command/atlas-backups-schedule-describe.txt +++ b/docs/command/atlas-backups-schedule-describe.txt @@ -14,6 +14,11 @@ atlas backups schedule describe Describe a cloud backup schedule for the cluster you specify. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-backups-schedule-update.txt b/docs/command/atlas-backups-schedule-update.txt index aa99e70631..86211468e0 100644 --- a/docs/command/atlas-backups-schedule-update.txt +++ b/docs/command/atlas-backups-schedule-update.txt @@ -14,6 +14,11 @@ atlas backups schedule update Modify the backup schedule for the specified cluster for your project. +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. + + + The backup schedule defines when MongoDB takes scheduled snapshots and how long it stores those snapshots. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-backups-schedule.txt b/docs/command/atlas-backups-schedule.txt index 3b3382244d..8af337ba2f 100644 --- a/docs/command/atlas-backups-schedule.txt +++ b/docs/command/atlas-backups-schedule.txt @@ -14,6 +14,13 @@ atlas backups schedule Return a cloud backup schedule for the cluster you specify. +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. + + + + + Options ------- diff --git a/docs/command/atlas-backups-snapshots-create.txt b/docs/command/atlas-backups-snapshots-create.txt index a9c24f0a57..4a2f813133 100644 --- a/docs/command/atlas-backups-snapshots-create.txt +++ b/docs/command/atlas-backups-snapshots-create.txt @@ -14,6 +14,11 @@ atlas backups snapshots create Create a backup snapshot for your project and cluster. +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. + + + You can create on-demand backup snapshots for Atlas cluster tiers M10 and larger. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-backups-snapshots-delete.txt b/docs/command/atlas-backups-snapshots-delete.txt index 99e44b55fc..05c247aaa9 100644 --- a/docs/command/atlas-backups-snapshots-delete.txt +++ b/docs/command/atlas-backups-snapshots-delete.txt @@ -14,6 +14,11 @@ atlas backups snapshots delete Remove the specified backup snapshot. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Atlas supports this command only for M10+ clusters. diff --git a/docs/command/atlas-backups-snapshots-describe.txt b/docs/command/atlas-backups-snapshots-describe.txt index 20bcc9f6e1..794c70b856 100644 --- a/docs/command/atlas-backups-snapshots-describe.txt +++ b/docs/command/atlas-backups-snapshots-describe.txt @@ -14,6 +14,11 @@ atlas backups snapshots describe Return the details for the specified snapshot for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-backups-snapshots-download.txt b/docs/command/atlas-backups-snapshots-download.txt index 11b570f992..0d18b8aa06 100644 --- a/docs/command/atlas-backups-snapshots-download.txt +++ b/docs/command/atlas-backups-snapshots-download.txt @@ -14,6 +14,11 @@ atlas backups snapshots download Download one snapshot for the specified flex cluster. +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. + + + You can download a snapshot for an Atlas Flex cluster. To use this command, you must authenticate with a user account or an API key with the Project Owner role. Atlas supports this command only for Flex clusters. diff --git a/docs/command/atlas-backups-snapshots-list.txt b/docs/command/atlas-backups-snapshots-list.txt index 4fee8008ea..ab98629bb9 100644 --- a/docs/command/atlas-backups-snapshots-list.txt +++ b/docs/command/atlas-backups-snapshots-list.txt @@ -14,6 +14,11 @@ atlas backups snapshots list Return all cloud backup snapshots for your project and cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-backups-snapshots-watch.txt b/docs/command/atlas-backups-snapshots-watch.txt index f17ed235fc..65a3a2e518 100644 --- a/docs/command/atlas-backups-snapshots-watch.txt +++ b/docs/command/atlas-backups-snapshots-watch.txt @@ -14,6 +14,11 @@ atlas backups snapshots watch Watch the specified snapshot in your project until it becomes available. +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. + + + This command checks the snapshot's status periodically until it reaches a completed or failed status. Once the snapshot reaches the expected status, the command prints "Snapshot changes completed." If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. diff --git a/docs/command/atlas-backups-snapshots.txt b/docs/command/atlas-backups-snapshots.txt index 028c6c021b..8ccde5d6f5 100644 --- a/docs/command/atlas-backups-snapshots.txt +++ b/docs/command/atlas-backups-snapshots.txt @@ -14,6 +14,13 @@ atlas backups snapshots Manage cloud backup snapshots for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-backups.txt b/docs/command/atlas-backups.txt index c04fe26d41..b02fa017ff 100644 --- a/docs/command/atlas-backups.txt +++ b/docs/command/atlas-backups.txt @@ -14,6 +14,13 @@ atlas backups Manage cloud backups for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-cloudProviders-accessRoles-aws-authorize.txt b/docs/command/atlas-cloudProviders-accessRoles-aws-authorize.txt index 63807f8d41..9e67b1db57 100644 --- a/docs/command/atlas-cloudProviders-accessRoles-aws-authorize.txt +++ b/docs/command/atlas-cloudProviders-accessRoles-aws-authorize.txt @@ -14,6 +14,13 @@ atlas cloudProviders accessRoles aws authorize Authorize an AWS IAM role. +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/docs/command/atlas-cloudProviders-accessRoles-aws-create.txt b/docs/command/atlas-cloudProviders-accessRoles-aws-create.txt index d9d9cc95a5..daa56658dd 100644 --- a/docs/command/atlas-cloudProviders-accessRoles-aws-create.txt +++ b/docs/command/atlas-cloudProviders-accessRoles-aws-create.txt @@ -14,6 +14,11 @@ atlas cloudProviders accessRoles aws create Create an AWS IAM role. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt b/docs/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt index cdb6f3e25b..5b891c2c41 100644 --- a/docs/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt +++ b/docs/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt @@ -14,6 +14,11 @@ atlas cloudProviders accessRoles aws deauthorize Deauthorize an AWS IAM role. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-cloudProviders-accessRoles-aws.txt b/docs/command/atlas-cloudProviders-accessRoles-aws.txt index 87be4ff42e..136a9d0d90 100644 --- a/docs/command/atlas-cloudProviders-accessRoles-aws.txt +++ b/docs/command/atlas-cloudProviders-accessRoles-aws.txt @@ -14,6 +14,13 @@ atlas cloudProviders accessRoles aws Manage AWS IAM role access in Atlas. +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. + + + + + Options ------- diff --git a/docs/command/atlas-cloudProviders-accessRoles-list.txt b/docs/command/atlas-cloudProviders-accessRoles-list.txt index f547b542a0..e21673a151 100644 --- a/docs/command/atlas-cloudProviders-accessRoles-list.txt +++ b/docs/command/atlas-cloudProviders-accessRoles-list.txt @@ -14,6 +14,11 @@ atlas cloudProviders accessRoles list List AWS IAM role access in Atlas. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-cloudProviders-accessRoles.txt b/docs/command/atlas-cloudProviders-accessRoles.txt index a0d5c04fa9..8a932a5bf3 100644 --- a/docs/command/atlas-cloudProviders-accessRoles.txt +++ b/docs/command/atlas-cloudProviders-accessRoles.txt @@ -14,6 +14,13 @@ atlas cloudProviders accessRoles Manage AWS IAM role access in Atlas. +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. + + + + + Options ------- diff --git a/docs/command/atlas-cloudProviders.txt b/docs/command/atlas-cloudProviders.txt index 397bdf243d..36918900f4 100644 --- a/docs/command/atlas-cloudProviders.txt +++ b/docs/command/atlas-cloudProviders.txt @@ -14,6 +14,13 @@ atlas cloudProviders Manage cloud provider access in Atlas using AWS IAM roles. +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. + + + + + Options ------- diff --git a/docs/command/atlas-clusters-advancedSettings-describe.txt b/docs/command/atlas-clusters-advancedSettings-describe.txt index da40aab20e..a799377a6b 100644 --- a/docs/command/atlas-clusters-advancedSettings-describe.txt +++ b/docs/command/atlas-clusters-advancedSettings-describe.txt @@ -14,6 +14,11 @@ atlas clusters advancedSettings describe Retrieve advanced configuration settings for one cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-clusters-advancedSettings-update.txt b/docs/command/atlas-clusters-advancedSettings-update.txt index 5017e010ae..39f245aa8f 100644 --- a/docs/command/atlas-clusters-advancedSettings-update.txt +++ b/docs/command/atlas-clusters-advancedSettings-update.txt @@ -14,6 +14,11 @@ atlas clusters advancedSettings update Update advanced configuration settings for one cluster. +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. + + + 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. Atlas supports this command only for M10+ clusters. diff --git a/docs/command/atlas-clusters-advancedSettings.txt b/docs/command/atlas-clusters-advancedSettings.txt index 206c7620db..e88b76fde2 100644 --- a/docs/command/atlas-clusters-advancedSettings.txt +++ b/docs/command/atlas-clusters-advancedSettings.txt @@ -14,6 +14,13 @@ atlas clusters advancedSettings Manage advanced configuration settings for your cluster. +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. + + + + + Options ------- diff --git a/docs/command/atlas-clusters-availableRegions-list.txt b/docs/command/atlas-clusters-availableRegions-list.txt index e0adf92e91..6443c0e954 100644 --- a/docs/command/atlas-clusters-availableRegions-list.txt +++ b/docs/command/atlas-clusters-availableRegions-list.txt @@ -14,6 +14,13 @@ atlas clusters availableRegions list List available regions that Atlas supports for new deployments. +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/docs/command/atlas-clusters-availableRegions.txt b/docs/command/atlas-clusters-availableRegions.txt index 56a43e7f4a..659e4cd7cf 100644 --- a/docs/command/atlas-clusters-availableRegions.txt +++ b/docs/command/atlas-clusters-availableRegions.txt @@ -14,6 +14,13 @@ atlas clusters availableRegions Manage available regions for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-clusters-connectionStrings-describe.txt b/docs/command/atlas-clusters-connectionStrings-describe.txt index 92b25f762c..434c26ca79 100644 --- a/docs/command/atlas-clusters-connectionStrings-describe.txt +++ b/docs/command/atlas-clusters-connectionStrings-describe.txt @@ -14,6 +14,11 @@ atlas clusters connectionStrings describe Return the SRV connection string for the cluster you specify. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-clusters-connectionStrings.txt b/docs/command/atlas-clusters-connectionStrings.txt index 0b206d8b56..beaeeb8c14 100644 --- a/docs/command/atlas-clusters-connectionStrings.txt +++ b/docs/command/atlas-clusters-connectionStrings.txt @@ -14,6 +14,13 @@ atlas clusters connectionStrings Manage MongoDB cluster connection string. +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. + + + + + Options ------- diff --git a/docs/command/atlas-clusters-create.txt b/docs/command/atlas-clusters-create.txt index 85bb0364c9..5e274f5784 100644 --- a/docs/command/atlas-clusters-create.txt +++ b/docs/command/atlas-clusters-create.txt @@ -14,6 +14,11 @@ atlas clusters create Create a cluster for your project. +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. + + + To get started quickly, specify a name for your cluster, a cloud provider, and a region to deploy a three-member replica set with the latest MongoDB server version. For full control of your deployment, or to create multi-cloud clusters, provide a JSON configuration file with the --file flag. diff --git a/docs/command/atlas-clusters-delete.txt b/docs/command/atlas-clusters-delete.txt index cf9404e96d..ea1199aa2c 100644 --- a/docs/command/atlas-clusters-delete.txt +++ b/docs/command/atlas-clusters-delete.txt @@ -14,6 +14,11 @@ atlas clusters delete Remove the specified cluster from your project. +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. + + + The command prompts you to confirm the operation when you run the command without the --force option. Deleting a cluster also deletes any backup snapshots for that cluster. diff --git a/docs/command/atlas-clusters-describe.txt b/docs/command/atlas-clusters-describe.txt index 859d243f87..22e5e2445c 100644 --- a/docs/command/atlas-clusters-describe.txt +++ b/docs/command/atlas-clusters-describe.txt @@ -14,6 +14,11 @@ atlas clusters describe Return the details for the specified cluster for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-clusters-failover.txt b/docs/command/atlas-clusters-failover.txt index 8d96a5dee8..cac047205c 100644 --- a/docs/command/atlas-clusters-failover.txt +++ b/docs/command/atlas-clusters-failover.txt @@ -14,6 +14,11 @@ atlas clusters failover Starts a failover test for the specified cluster in the specified project. +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. + + + 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. Syntax diff --git a/docs/command/atlas-clusters-indexes-create.txt b/docs/command/atlas-clusters-indexes-create.txt index b0ab8cec36..3b73e401e9 100644 --- a/docs/command/atlas-clusters-indexes-create.txt +++ b/docs/command/atlas-clusters-indexes-create.txt @@ -14,6 +14,11 @@ atlas clusters indexes create Create a rolling index for the specified cluster for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/docs/command/atlas-clusters-indexes.txt b/docs/command/atlas-clusters-indexes.txt index 2fb07225f6..0b908df2ab 100644 --- a/docs/command/atlas-clusters-indexes.txt +++ b/docs/command/atlas-clusters-indexes.txt @@ -14,6 +14,13 @@ atlas clusters indexes Manage cluster rolling indexes for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-clusters-list.txt b/docs/command/atlas-clusters-list.txt index 4c6815e5b5..d40af98889 100644 --- a/docs/command/atlas-clusters-list.txt +++ b/docs/command/atlas-clusters-list.txt @@ -14,6 +14,11 @@ atlas clusters list Return all clusters for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-clusters-onlineArchives-create.txt b/docs/command/atlas-clusters-onlineArchives-create.txt index 807caab592..b7d4e6b1cb 100644 --- a/docs/command/atlas-clusters-onlineArchives-create.txt +++ b/docs/command/atlas-clusters-onlineArchives-create.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives create Create an online archive for a collection in the specified cluster. +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. + + + You can create an online archive for an M10 or larger cluster. To learn more about online archives, see https://www.mongodb.com/docs/atlas/online-archive/manage-online-archive/. diff --git a/docs/command/atlas-clusters-onlineArchives-delete.txt b/docs/command/atlas-clusters-onlineArchives-delete.txt index 1565262de1..1e270f0d5c 100644 --- a/docs/command/atlas-clusters-onlineArchives-delete.txt +++ b/docs/command/atlas-clusters-onlineArchives-delete.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives delete Remove the specified online archive from your cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/docs/command/atlas-clusters-onlineArchives-describe.txt b/docs/command/atlas-clusters-onlineArchives-describe.txt index 61d98b1ab0..b367a735dc 100644 --- a/docs/command/atlas-clusters-onlineArchives-describe.txt +++ b/docs/command/atlas-clusters-onlineArchives-describe.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives describe Return the details for the specified online archive for your cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-clusters-onlineArchives-list.txt b/docs/command/atlas-clusters-onlineArchives-list.txt index 31303c36d0..c431fd5954 100644 --- a/docs/command/atlas-clusters-onlineArchives-list.txt +++ b/docs/command/atlas-clusters-onlineArchives-list.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives list Return all online archives for your cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-clusters-onlineArchives-pause.txt b/docs/command/atlas-clusters-onlineArchives-pause.txt index 996bf97623..20b2332fe3 100644 --- a/docs/command/atlas-clusters-onlineArchives-pause.txt +++ b/docs/command/atlas-clusters-onlineArchives-pause.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives pause Pause the specfied online archive for your cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/docs/command/atlas-clusters-onlineArchives-start.txt b/docs/command/atlas-clusters-onlineArchives-start.txt index 9b9f22efdd..edfaca7889 100644 --- a/docs/command/atlas-clusters-onlineArchives-start.txt +++ b/docs/command/atlas-clusters-onlineArchives-start.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives start Start a paused online archive from a cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/docs/command/atlas-clusters-onlineArchives-update.txt b/docs/command/atlas-clusters-onlineArchives-update.txt index 53ee303d8d..6e147f2b89 100644 --- a/docs/command/atlas-clusters-onlineArchives-update.txt +++ b/docs/command/atlas-clusters-onlineArchives-update.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives update Modify the archiving rule for the specified online archive for a cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/docs/command/atlas-clusters-onlineArchives-watch.txt b/docs/command/atlas-clusters-onlineArchives-watch.txt index dd7d016207..0978c01ce4 100644 --- a/docs/command/atlas-clusters-onlineArchives-watch.txt +++ b/docs/command/atlas-clusters-onlineArchives-watch.txt @@ -14,6 +14,11 @@ atlas clusters onlineArchives watch Watch for an archive to be available. +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. + + + This command checks the archive's status periodically until it reaches a state different from PENDING or PAUSING. Once the archive reaches the expected status, the command prints "Online archive available." If you run the command in the terminal, it blocks the terminal session until the resource status changes to the expected status. diff --git a/docs/command/atlas-clusters-onlineArchives.txt b/docs/command/atlas-clusters-onlineArchives.txt index b689acf59a..bd566ac194 100644 --- a/docs/command/atlas-clusters-onlineArchives.txt +++ b/docs/command/atlas-clusters-onlineArchives.txt @@ -14,6 +14,13 @@ atlas clusters onlineArchives Manage online archives for your cluster. +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. + + + + + Options ------- diff --git a/docs/command/atlas-clusters-pause.txt b/docs/command/atlas-clusters-pause.txt index 6f369603dc..9ee26227ac 100644 --- a/docs/command/atlas-clusters-pause.txt +++ b/docs/command/atlas-clusters-pause.txt @@ -14,6 +14,11 @@ atlas clusters pause Pause the specified running MongoDB cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. Atlas supports this command only for M10+ clusters. diff --git a/docs/command/atlas-clusters-sampleData-describe.txt b/docs/command/atlas-clusters-sampleData-describe.txt index 4582679f53..29b6c531cf 100644 --- a/docs/command/atlas-clusters-sampleData-describe.txt +++ b/docs/command/atlas-clusters-sampleData-describe.txt @@ -14,6 +14,11 @@ atlas clusters sampleData describe Return the details for the specified sample data load job. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-clusters-sampleData-load.txt b/docs/command/atlas-clusters-sampleData-load.txt index 89f96848c5..bec2a5b68d 100644 --- a/docs/command/atlas-clusters-sampleData-load.txt +++ b/docs/command/atlas-clusters-sampleData-load.txt @@ -14,6 +14,11 @@ atlas clusters sampleData load Load sample data into the specified cluster for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-clusters-sampleData-watch.txt b/docs/command/atlas-clusters-sampleData-watch.txt index 6999b01897..5546b53d64 100644 --- a/docs/command/atlas-clusters-sampleData-watch.txt +++ b/docs/command/atlas-clusters-sampleData-watch.txt @@ -14,6 +14,11 @@ atlas clusters sampleData watch Watch the specified sample data job in your cluster until it completes. +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. + + + This command checks the sample data job's status periodically until it reaches an COMPLETED state. If you run the command in the terminal, it blocks the terminal session until the resource state changes to COMPLETED. You can interrupt the command's polling at any time with CTRL-C. diff --git a/docs/command/atlas-clusters-sampleData.txt b/docs/command/atlas-clusters-sampleData.txt index 60fb597813..1b8dedeb94 100644 --- a/docs/command/atlas-clusters-sampleData.txt +++ b/docs/command/atlas-clusters-sampleData.txt @@ -14,6 +14,11 @@ atlas clusters sampleData Manage sample data for your cluster. +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. + + + The sampleData command provides access to sample data to be loaded onto your cluster. Options diff --git a/docs/command/atlas-clusters-search-indexes-create.txt b/docs/command/atlas-clusters-search-indexes-create.txt index 798abf7b66..b33966e2d9 100644 --- a/docs/command/atlas-clusters-search-indexes-create.txt +++ b/docs/command/atlas-clusters-search-indexes-create.txt @@ -14,6 +14,11 @@ atlas clusters search indexes create Create a search index for a cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/docs/command/atlas-clusters-search-indexes-delete.txt b/docs/command/atlas-clusters-search-indexes-delete.txt index 7541ce1050..f25f528d2e 100644 --- a/docs/command/atlas-clusters-search-indexes-delete.txt +++ b/docs/command/atlas-clusters-search-indexes-delete.txt @@ -14,6 +14,11 @@ atlas clusters search indexes delete Delete the specified search index from the specified cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/docs/command/atlas-clusters-search-indexes-describe.txt b/docs/command/atlas-clusters-search-indexes-describe.txt index eef63fa825..d517a5a841 100644 --- a/docs/command/atlas-clusters-search-indexes-describe.txt +++ b/docs/command/atlas-clusters-search-indexes-describe.txt @@ -14,6 +14,11 @@ atlas clusters search indexes describe Return the details for the search index for a cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. Syntax diff --git a/docs/command/atlas-clusters-search-indexes-list.txt b/docs/command/atlas-clusters-search-indexes-list.txt index e17eb4d23a..b0f4e58a67 100644 --- a/docs/command/atlas-clusters-search-indexes-list.txt +++ b/docs/command/atlas-clusters-search-indexes-list.txt @@ -14,6 +14,11 @@ atlas clusters search indexes list List all Atlas Search indexes for a cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. Syntax diff --git a/docs/command/atlas-clusters-search-indexes-update.txt b/docs/command/atlas-clusters-search-indexes-update.txt index 87c5a17dd3..e3edfec242 100644 --- a/docs/command/atlas-clusters-search-indexes-update.txt +++ b/docs/command/atlas-clusters-search-indexes-update.txt @@ -14,6 +14,11 @@ atlas clusters search indexes update Modify a search index for a cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. Syntax diff --git a/docs/command/atlas-clusters-search-indexes.txt b/docs/command/atlas-clusters-search-indexes.txt index 160e679678..df172b1461 100644 --- a/docs/command/atlas-clusters-search-indexes.txt +++ b/docs/command/atlas-clusters-search-indexes.txt @@ -14,6 +14,13 @@ atlas clusters search indexes Manage Atlas Search indexes for your cluster. +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. + + + + + Options ------- diff --git a/docs/command/atlas-clusters-search-nodes-create.txt b/docs/command/atlas-clusters-search-nodes-create.txt index b60cc0fa92..51cf4881d6 100644 --- a/docs/command/atlas-clusters-search-nodes-create.txt +++ b/docs/command/atlas-clusters-search-nodes-create.txt @@ -14,6 +14,11 @@ atlas clusters search nodes create Create a search node for a cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role. Syntax diff --git a/docs/command/atlas-clusters-search-nodes-delete.txt b/docs/command/atlas-clusters-search-nodes-delete.txt index fff9832631..5666a2097b 100644 --- a/docs/command/atlas-clusters-search-nodes-delete.txt +++ b/docs/command/atlas-clusters-search-nodes-delete.txt @@ -14,6 +14,11 @@ atlas clusters search nodes delete Delete a search node for a cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role. Syntax diff --git a/docs/command/atlas-clusters-search-nodes-list.txt b/docs/command/atlas-clusters-search-nodes-list.txt index c0d3460121..4c2c81751b 100644 --- a/docs/command/atlas-clusters-search-nodes-list.txt +++ b/docs/command/atlas-clusters-search-nodes-list.txt @@ -14,6 +14,11 @@ atlas clusters search nodes list List all Atlas Search nodes for a cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-clusters-search-nodes-update.txt b/docs/command/atlas-clusters-search-nodes-update.txt index bab41d6284..4d1f31d834 100644 --- a/docs/command/atlas-clusters-search-nodes-update.txt +++ b/docs/command/atlas-clusters-search-nodes-update.txt @@ -14,6 +14,11 @@ atlas clusters search nodes update Update a search node for a cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role. Syntax diff --git a/docs/command/atlas-clusters-search-nodes.txt b/docs/command/atlas-clusters-search-nodes.txt index 958a089711..15c2497387 100644 --- a/docs/command/atlas-clusters-search-nodes.txt +++ b/docs/command/atlas-clusters-search-nodes.txt @@ -14,6 +14,13 @@ atlas clusters search nodes Manage Atlas Search nodes for your cluster. +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. + + + + + Options ------- diff --git a/docs/command/atlas-clusters-search.txt b/docs/command/atlas-clusters-search.txt index d8ffd2b0ba..0cf13ee0ae 100644 --- a/docs/command/atlas-clusters-search.txt +++ b/docs/command/atlas-clusters-search.txt @@ -14,6 +14,13 @@ atlas clusters search Manage Atlas Search for your cluster. +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. + + + + + Options ------- diff --git a/docs/command/atlas-clusters-start.txt b/docs/command/atlas-clusters-start.txt index 943c8f079f..785cfb5f69 100644 --- a/docs/command/atlas-clusters-start.txt +++ b/docs/command/atlas-clusters-start.txt @@ -14,6 +14,11 @@ atlas clusters start Start the specified paused MongoDB cluster. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. Atlas supports this command only for M10+ clusters. diff --git a/docs/command/atlas-clusters-update.txt b/docs/command/atlas-clusters-update.txt index 3275c92b1f..2f286682f8 100644 --- a/docs/command/atlas-clusters-update.txt +++ b/docs/command/atlas-clusters-update.txt @@ -14,6 +14,11 @@ atlas clusters update Modify the settings of the specified cluster. +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. + + + You can specify modifications in a JSON configuration file with the --file flag. You can't change the name of the cluster or downgrade the MongoDB version of your cluster. diff --git a/docs/command/atlas-clusters-upgrade.txt b/docs/command/atlas-clusters-upgrade.txt index 59b913b58a..5e8a33089a 100644 --- a/docs/command/atlas-clusters-upgrade.txt +++ b/docs/command/atlas-clusters-upgrade.txt @@ -14,6 +14,11 @@ atlas clusters upgrade Upgrade a shared cluster's tier, disk size, and/or MongoDB version. +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. + + + This command is unavailable for dedicated clusters. To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. diff --git a/docs/command/atlas-clusters-watch.txt b/docs/command/atlas-clusters-watch.txt index 9370e54689..d5fd242dd8 100644 --- a/docs/command/atlas-clusters-watch.txt +++ b/docs/command/atlas-clusters-watch.txt @@ -14,6 +14,11 @@ atlas clusters watch Watch the specified cluster in your project until it becomes available. +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. + + + This command checks the cluster's status periodically until it reaches an IDLE state. Once the cluster reaches the expected state, the command prints "Cluster available." If you run the command in the terminal, it blocks the terminal session until the resource state changes to IDLE. diff --git a/docs/command/atlas-clusters.txt b/docs/command/atlas-clusters.txt index 5f49f0d466..898080279d 100644 --- a/docs/command/atlas-clusters.txt +++ b/docs/command/atlas-clusters.txt @@ -14,6 +14,11 @@ atlas clusters Manage clusters for your project. +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. + + + The clusters command provides access to your cluster configurations. You can create, edit, and delete clusters. Options diff --git a/docs/command/atlas-completion-fish.txt b/docs/command/atlas-completion-fish.txt index cdb18085f7..88493a2445 100644 --- a/docs/command/atlas-completion-fish.txt +++ b/docs/command/atlas-completion-fish.txt @@ -14,6 +14,11 @@ atlas completion fish Generate the autocompletion script for fish +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. + + + Generate the autocompletion script for the fish shell. To load completions in your current shell session: diff --git a/docs/command/atlas-completion-powershell.txt b/docs/command/atlas-completion-powershell.txt index 4ec9d22b11..92864e69de 100644 --- a/docs/command/atlas-completion-powershell.txt +++ b/docs/command/atlas-completion-powershell.txt @@ -14,6 +14,11 @@ atlas completion powershell Generate the autocompletion script for powershell +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. + + + Generate the autocompletion script for powershell. To load completions in your current shell session: diff --git a/docs/command/atlas-completion-zsh.txt b/docs/command/atlas-completion-zsh.txt index f5052fa504..39ddc5fbaa 100644 --- a/docs/command/atlas-completion-zsh.txt +++ b/docs/command/atlas-completion-zsh.txt @@ -14,6 +14,11 @@ atlas completion zsh Generate the autocompletion script for zsh +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. + + + Generate the autocompletion script for the zsh shell. If shell completion is not already enabled in your environment you will need diff --git a/docs/command/atlas-completion.txt b/docs/command/atlas-completion.txt index 57d74af29c..8ae0cc0b34 100644 --- a/docs/command/atlas-completion.txt +++ b/docs/command/atlas-completion.txt @@ -14,6 +14,11 @@ atlas completion Generate the autocompletion script for the specified shell +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. + + + Generate the autocompletion script for atlas for the specified shell. See each sub-command's help for details on how to use the generated script. diff --git a/docs/command/atlas-config-delete.txt b/docs/command/atlas-config-delete.txt index 767cc09906..37d961a176 100644 --- a/docs/command/atlas-config-delete.txt +++ b/docs/command/atlas-config-delete.txt @@ -14,6 +14,13 @@ atlas config delete Delete a profile. +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/docs/command/atlas-config-describe.txt b/docs/command/atlas-config-describe.txt index 56359f1812..b1911dcf9b 100644 --- a/docs/command/atlas-config-describe.txt +++ b/docs/command/atlas-config-describe.txt @@ -14,6 +14,13 @@ atlas config describe Return the profile you specify. +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/docs/command/atlas-config-edit.txt b/docs/command/atlas-config-edit.txt index 3f79872c73..ec1478b022 100644 --- a/docs/command/atlas-config-edit.txt +++ b/docs/command/atlas-config-edit.txt @@ -14,6 +14,11 @@ atlas config edit Opens the config file with the default text editor. +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. + + + Uses the default editor to open the config file. You can use EDITOR or VISUAL envs to change the default. Syntax diff --git a/docs/command/atlas-config-init.txt b/docs/command/atlas-config-init.txt index 5869b38318..8f19185975 100644 --- a/docs/command/atlas-config-init.txt +++ b/docs/command/atlas-config-init.txt @@ -14,6 +14,13 @@ atlas config init Configure a profile to store access settings for your MongoDB deployment. +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/docs/command/atlas-config-list.txt b/docs/command/atlas-config-list.txt index 36cee08ac7..f4d337930e 100644 --- a/docs/command/atlas-config-list.txt +++ b/docs/command/atlas-config-list.txt @@ -14,6 +14,11 @@ atlas config list Return a list of available profiles by name. +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. + + + If you did not specify a name for your profile, it displays as the default profile. Syntax diff --git a/docs/command/atlas-config-rename.txt b/docs/command/atlas-config-rename.txt index cd801e52d7..f0ab398ac8 100644 --- a/docs/command/atlas-config-rename.txt +++ b/docs/command/atlas-config-rename.txt @@ -14,6 +14,13 @@ atlas config rename Rename a profile. +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/docs/command/atlas-config-set.txt b/docs/command/atlas-config-set.txt index dd1be889b6..b2bf1ec57c 100644 --- a/docs/command/atlas-config-set.txt +++ b/docs/command/atlas-config-set.txt @@ -14,6 +14,13 @@ atlas config set Configure specific properties of a profile. +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/docs/command/atlas-config.txt b/docs/command/atlas-config.txt index 407faf6a3a..14f6b198bb 100644 --- a/docs/command/atlas-config.txt +++ b/docs/command/atlas-config.txt @@ -14,6 +14,11 @@ atlas config Configure and manage your user profiles. +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. + + + Configure settings in a user profile. All settings are optional. You can specify settings individually by running: $ atlas config set --help diff --git a/docs/command/atlas-customDbRoles-create.txt b/docs/command/atlas-customDbRoles-create.txt index 9b8a215906..1e5ab98d89 100644 --- a/docs/command/atlas-customDbRoles-create.txt +++ b/docs/command/atlas-customDbRoles-create.txt @@ -14,6 +14,11 @@ atlas customDbRoles create Create a custom database role for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-customDbRoles-delete.txt b/docs/command/atlas-customDbRoles-delete.txt index 15ac1aa8a1..eba3c574de 100644 --- a/docs/command/atlas-customDbRoles-delete.txt +++ b/docs/command/atlas-customDbRoles-delete.txt @@ -14,6 +14,11 @@ atlas customDbRoles delete Remove the specified custom database role from your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-customDbRoles-describe.txt b/docs/command/atlas-customDbRoles-describe.txt index fc55e02673..10cae21512 100644 --- a/docs/command/atlas-customDbRoles-describe.txt +++ b/docs/command/atlas-customDbRoles-describe.txt @@ -14,6 +14,11 @@ atlas customDbRoles describe Return a single custom database role for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-customDbRoles-list.txt b/docs/command/atlas-customDbRoles-list.txt index 68e8f8d518..8e256bf775 100644 --- a/docs/command/atlas-customDbRoles-list.txt +++ b/docs/command/atlas-customDbRoles-list.txt @@ -14,6 +14,11 @@ atlas customDbRoles list List custom database roles for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-customDbRoles-update.txt b/docs/command/atlas-customDbRoles-update.txt index eb665640dc..619ca0f433 100644 --- a/docs/command/atlas-customDbRoles-update.txt +++ b/docs/command/atlas-customDbRoles-update.txt @@ -14,6 +14,11 @@ atlas customDbRoles update Update a custom database role for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-customDbRoles.txt b/docs/command/atlas-customDbRoles.txt index 674eaa626a..ec12e4f561 100644 --- a/docs/command/atlas-customDbRoles.txt +++ b/docs/command/atlas-customDbRoles.txt @@ -14,6 +14,13 @@ atlas customDbRoles Manage custom database roles for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-customDns-aws-describe.txt b/docs/command/atlas-customDns-aws-describe.txt index f19e00caa6..d25889d6c5 100644 --- a/docs/command/atlas-customDns-aws-describe.txt +++ b/docs/command/atlas-customDns-aws-describe.txt @@ -14,6 +14,11 @@ atlas customDns aws describe Describe the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-customDns-aws-disable.txt b/docs/command/atlas-customDns-aws-disable.txt index fe8931480d..998a037f19 100644 --- a/docs/command/atlas-customDns-aws-disable.txt +++ b/docs/command/atlas-customDns-aws-disable.txt @@ -14,6 +14,11 @@ atlas customDns aws disable Disable the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-customDns-aws-enable.txt b/docs/command/atlas-customDns-aws-enable.txt index 7ebf795a8b..e42dec039e 100644 --- a/docs/command/atlas-customDns-aws-enable.txt +++ b/docs/command/atlas-customDns-aws-enable.txt @@ -14,6 +14,11 @@ atlas customDns aws enable Enable the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-customDns-aws.txt b/docs/command/atlas-customDns-aws.txt index 2b385960ad..7c0ae6f4c5 100644 --- a/docs/command/atlas-customDns-aws.txt +++ b/docs/command/atlas-customDns-aws.txt @@ -14,6 +14,13 @@ atlas customDns aws Manage DNS configuration of an Atlas project’s cluster deployed to AWS. +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. + + + + + Options ------- diff --git a/docs/command/atlas-customDns.txt b/docs/command/atlas-customDns.txt index a613a48d18..a1acf0bf97 100644 --- a/docs/command/atlas-customDns.txt +++ b/docs/command/atlas-customDns.txt @@ -14,6 +14,13 @@ atlas customDns Manage DNS configuration of Atlas project’s clusters deployed to AWS. +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. + + + + + Options ------- diff --git a/docs/command/atlas-dataFederation-create.txt b/docs/command/atlas-dataFederation-create.txt index cb56350eae..d5de6d016c 100644 --- a/docs/command/atlas-dataFederation-create.txt +++ b/docs/command/atlas-dataFederation-create.txt @@ -14,6 +14,11 @@ atlas dataFederation create Creates a new Data Federation database. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation-delete.txt b/docs/command/atlas-dataFederation-delete.txt index e382667aa3..46080bd311 100644 --- a/docs/command/atlas-dataFederation-delete.txt +++ b/docs/command/atlas-dataFederation-delete.txt @@ -14,6 +14,11 @@ atlas dataFederation delete Remove the specified data federation database from your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation-describe.txt b/docs/command/atlas-dataFederation-describe.txt index 5499f34860..ec1c187e05 100644 --- a/docs/command/atlas-dataFederation-describe.txt +++ b/docs/command/atlas-dataFederation-describe.txt @@ -14,6 +14,11 @@ atlas dataFederation describe Return the details for the specified data federation database for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation-list.txt b/docs/command/atlas-dataFederation-list.txt index 59c6ee9682..e61d582ca0 100644 --- a/docs/command/atlas-dataFederation-list.txt +++ b/docs/command/atlas-dataFederation-list.txt @@ -14,6 +14,11 @@ atlas dataFederation list Returns all data federation databases for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-dataFederation-logs.txt b/docs/command/atlas-dataFederation-logs.txt index 708beaf639..6a780c1390 100644 --- a/docs/command/atlas-dataFederation-logs.txt +++ b/docs/command/atlas-dataFederation-logs.txt @@ -14,6 +14,11 @@ atlas dataFederation logs Returns logs of the specified data federation database for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-dataFederation-privateEndpoints-create.txt b/docs/command/atlas-dataFederation-privateEndpoints-create.txt index 92cbbefc52..3ce4302f69 100644 --- a/docs/command/atlas-dataFederation-privateEndpoints-create.txt +++ b/docs/command/atlas-dataFederation-privateEndpoints-create.txt @@ -14,6 +14,11 @@ atlas dataFederation privateEndpoints create Creates a new Data Federation private endpoint. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation-privateEndpoints-delete.txt b/docs/command/atlas-dataFederation-privateEndpoints-delete.txt index b120e76382..19b005a764 100644 --- a/docs/command/atlas-dataFederation-privateEndpoints-delete.txt +++ b/docs/command/atlas-dataFederation-privateEndpoints-delete.txt @@ -14,6 +14,11 @@ atlas dataFederation privateEndpoints delete Remove the specified data federation private endpoint from your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation-privateEndpoints-describe.txt b/docs/command/atlas-dataFederation-privateEndpoints-describe.txt index f6c4a32295..fb88777c7a 100644 --- a/docs/command/atlas-dataFederation-privateEndpoints-describe.txt +++ b/docs/command/atlas-dataFederation-privateEndpoints-describe.txt @@ -14,6 +14,11 @@ atlas dataFederation privateEndpoints describe Return the details for the specified data federation private endpoint for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation-privateEndpoints-list.txt b/docs/command/atlas-dataFederation-privateEndpoints-list.txt index 11c74755fa..975143246d 100644 --- a/docs/command/atlas-dataFederation-privateEndpoints-list.txt +++ b/docs/command/atlas-dataFederation-privateEndpoints-list.txt @@ -14,6 +14,11 @@ atlas dataFederation privateEndpoints list Returns all data federation private endpoints for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-dataFederation-privateEndpoints.txt b/docs/command/atlas-dataFederation-privateEndpoints.txt index 2bb92609a9..8648735cde 100644 --- a/docs/command/atlas-dataFederation-privateEndpoints.txt +++ b/docs/command/atlas-dataFederation-privateEndpoints.txt @@ -14,6 +14,13 @@ atlas dataFederation privateEndpoints Data federation private endpoints. +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. + + + + + Options ------- diff --git a/docs/command/atlas-dataFederation-queryLimits-create.txt b/docs/command/atlas-dataFederation-queryLimits-create.txt index eaa5f1f2cf..32d7ac2672 100644 --- a/docs/command/atlas-dataFederation-queryLimits-create.txt +++ b/docs/command/atlas-dataFederation-queryLimits-create.txt @@ -14,6 +14,11 @@ atlas dataFederation queryLimits create Creates a new Data Federation query limit. +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. + + + To learn more about the query limits, see https://dochub.mongodb.org/core/adf-query-limits.To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation-queryLimits-delete.txt b/docs/command/atlas-dataFederation-queryLimits-delete.txt index 3291c783d6..dcb374aaaa 100644 --- a/docs/command/atlas-dataFederation-queryLimits-delete.txt +++ b/docs/command/atlas-dataFederation-queryLimits-delete.txt @@ -14,6 +14,11 @@ atlas dataFederation queryLimits delete Remove the specified data federation query limit from your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation-queryLimits-describe.txt b/docs/command/atlas-dataFederation-queryLimits-describe.txt index 63f1b1b213..ccf46e5925 100644 --- a/docs/command/atlas-dataFederation-queryLimits-describe.txt +++ b/docs/command/atlas-dataFederation-queryLimits-describe.txt @@ -14,6 +14,11 @@ atlas dataFederation queryLimits describe Return the details for the specified data federation query limit for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation-queryLimits-list.txt b/docs/command/atlas-dataFederation-queryLimits-list.txt index 9f30232375..8408b8bf69 100644 --- a/docs/command/atlas-dataFederation-queryLimits-list.txt +++ b/docs/command/atlas-dataFederation-queryLimits-list.txt @@ -14,6 +14,11 @@ atlas dataFederation queryLimits list Returns all data federation query limits for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-dataFederation-queryLimits.txt b/docs/command/atlas-dataFederation-queryLimits.txt index 9667d5ede8..16bec56f2e 100644 --- a/docs/command/atlas-dataFederation-queryLimits.txt +++ b/docs/command/atlas-dataFederation-queryLimits.txt @@ -14,6 +14,13 @@ atlas dataFederation queryLimits Data federation query limits. +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. + + + + + Options ------- diff --git a/docs/command/atlas-dataFederation-update.txt b/docs/command/atlas-dataFederation-update.txt index 9efe96d462..3600b5c81f 100644 --- a/docs/command/atlas-dataFederation-update.txt +++ b/docs/command/atlas-dataFederation-update.txt @@ -14,6 +14,11 @@ atlas dataFederation update Modify the details of the specified data federation database for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dataFederation.txt b/docs/command/atlas-dataFederation.txt index f548e43470..585465dd3e 100644 --- a/docs/command/atlas-dataFederation.txt +++ b/docs/command/atlas-dataFederation.txt @@ -14,6 +14,13 @@ atlas dataFederation Data federation. +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. + + + + + Options ------- diff --git a/docs/command/atlas-dbusers-certs-create.txt b/docs/command/atlas-dbusers-certs-create.txt index a5771b97af..283c7a416c 100644 --- a/docs/command/atlas-dbusers-certs-create.txt +++ b/docs/command/atlas-dbusers-certs-create.txt @@ -14,6 +14,11 @@ atlas dbusers certs create Create a new Atlas-managed X.509 certificate for the specified database user. +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. + + + The user you specify must authenticate using X.509 certificates. You can't use this command to create certificates if you are managing your own Certificate Authority (CA) in self-managed X.509 mode. Syntax diff --git a/docs/command/atlas-dbusers-certs-list.txt b/docs/command/atlas-dbusers-certs-list.txt index fd6999647e..d3d5556f54 100644 --- a/docs/command/atlas-dbusers-certs-list.txt +++ b/docs/command/atlas-dbusers-certs-list.txt @@ -14,6 +14,11 @@ atlas dbusers certs list Return all Atlas-managed, unexpired X.509 certificates for the specified database user. +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. + + + You can't use this command to return certificates if you are managing your own Certificate Authority (CA) in self-managed X.509 mode. The user you specify must authenticate using X.509 certificates. diff --git a/docs/command/atlas-dbusers-certs.txt b/docs/command/atlas-dbusers-certs.txt index e5cf674a70..fa3cea6d57 100644 --- a/docs/command/atlas-dbusers-certs.txt +++ b/docs/command/atlas-dbusers-certs.txt @@ -14,6 +14,13 @@ atlas dbusers certs Manage Atlas x509 certificates for your database users. +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. + + + + + Options ------- diff --git a/docs/command/atlas-dbusers-create.txt b/docs/command/atlas-dbusers-create.txt index 53cf35d052..36cc6c8686 100644 --- a/docs/command/atlas-dbusers-create.txt +++ b/docs/command/atlas-dbusers-create.txt @@ -14,6 +14,11 @@ atlas dbusers create Create a database user for your project. +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. + + + If you set --ldapType, --x509Type, --oidcType and --awsIAMType to NONE, Atlas authenticates this user through SCRAM-SHA. To learn more, see https://www.mongodb.com/docs/manual/core/security-scram/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-dbusers-delete.txt b/docs/command/atlas-dbusers-delete.txt index 78e7aec17f..07b6d47976 100644 --- a/docs/command/atlas-dbusers-delete.txt +++ b/docs/command/atlas-dbusers-delete.txt @@ -14,6 +14,11 @@ atlas dbusers delete Remove the specified database user from your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dbusers-describe.txt b/docs/command/atlas-dbusers-describe.txt index 275db941a8..0eda7d3385 100644 --- a/docs/command/atlas-dbusers-describe.txt +++ b/docs/command/atlas-dbusers-describe.txt @@ -14,6 +14,11 @@ atlas dbusers describe Return the details for the specified database user for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-dbusers-list.txt b/docs/command/atlas-dbusers-list.txt index cebb33b69f..71f5832561 100644 --- a/docs/command/atlas-dbusers-list.txt +++ b/docs/command/atlas-dbusers-list.txt @@ -14,6 +14,11 @@ atlas dbusers list Return all database users for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-dbusers-update.txt b/docs/command/atlas-dbusers-update.txt index 55583100e8..bd178e4ab3 100644 --- a/docs/command/atlas-dbusers-update.txt +++ b/docs/command/atlas-dbusers-update.txt @@ -14,6 +14,11 @@ atlas dbusers update Modify the details of a database user in your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-dbusers.txt b/docs/command/atlas-dbusers.txt index bf2938b99d..1b8e01d1a5 100644 --- a/docs/command/atlas-dbusers.txt +++ b/docs/command/atlas-dbusers.txt @@ -14,6 +14,11 @@ atlas dbusers Manage database users for your project. +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. + + + The dbusers command retrieves, creates and modifies the MongoDB database users in your project. Each user has a set of roles that provide access to the project’s databases. A user’s roles apply to all the clusters in the project. diff --git a/docs/command/atlas-deployments-connect.txt b/docs/command/atlas-deployments-connect.txt index ba7a01e12e..5b1d66b10b 100644 --- a/docs/command/atlas-deployments-connect.txt +++ b/docs/command/atlas-deployments-connect.txt @@ -14,6 +14,13 @@ atlas deployments connect Connect to a deployment that is running locally or in Atlas. If the deployment is paused, make sure to run atlas deployments start first. +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/docs/command/atlas-deployments-delete.txt b/docs/command/atlas-deployments-delete.txt index 7da47cbad1..e6f063c2c6 100644 --- a/docs/command/atlas-deployments-delete.txt +++ b/docs/command/atlas-deployments-delete.txt @@ -14,6 +14,11 @@ atlas deployments delete Delete a deployment. +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. + + + The command prompts you to confirm the operation when you run the command without the --force option. Deleting an Atlas deployment also deletes any backup snapshots for that cluster. diff --git a/docs/command/atlas-deployments-list.txt b/docs/command/atlas-deployments-list.txt index 6cd4592154..c1f02a3a97 100644 --- a/docs/command/atlas-deployments-list.txt +++ b/docs/command/atlas-deployments-list.txt @@ -14,6 +14,13 @@ atlas deployments list Return all deployments. +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/docs/command/atlas-deployments-logs.txt b/docs/command/atlas-deployments-logs.txt index 9d4c889676..db3399045b 100644 --- a/docs/command/atlas-deployments-logs.txt +++ b/docs/command/atlas-deployments-logs.txt @@ -14,6 +14,13 @@ atlas deployments logs Get deployment logs. +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/docs/command/atlas-deployments-pause.txt b/docs/command/atlas-deployments-pause.txt index 0508178d28..5d5f05cab9 100644 --- a/docs/command/atlas-deployments-pause.txt +++ b/docs/command/atlas-deployments-pause.txt @@ -14,6 +14,13 @@ atlas deployments pause Pause a deployment. +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/docs/command/atlas-deployments-search-indexes-create.txt b/docs/command/atlas-deployments-search-indexes-create.txt index 6948f1a187..692d8f40f5 100644 --- a/docs/command/atlas-deployments-search-indexes-create.txt +++ b/docs/command/atlas-deployments-search-indexes-create.txt @@ -14,6 +14,13 @@ atlas deployments search indexes create Create a search index for the specified deployment. +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/docs/command/atlas-deployments-search-indexes-delete.txt b/docs/command/atlas-deployments-search-indexes-delete.txt index 49f5287e6b..51de8a1b6f 100644 --- a/docs/command/atlas-deployments-search-indexes-delete.txt +++ b/docs/command/atlas-deployments-search-indexes-delete.txt @@ -14,6 +14,13 @@ atlas deployments search indexes delete Delete the specified search index from the specified deployment. +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/docs/command/atlas-deployments-search-indexes-describe.txt b/docs/command/atlas-deployments-search-indexes-describe.txt index fef7fb2e84..adf5bc3f48 100644 --- a/docs/command/atlas-deployments-search-indexes-describe.txt +++ b/docs/command/atlas-deployments-search-indexes-describe.txt @@ -14,6 +14,13 @@ atlas deployments search indexes describe Describe a search index for the specified deployment. +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/docs/command/atlas-deployments-search-indexes-list.txt b/docs/command/atlas-deployments-search-indexes-list.txt index 75ba7080a4..0123dd23c9 100644 --- a/docs/command/atlas-deployments-search-indexes-list.txt +++ b/docs/command/atlas-deployments-search-indexes-list.txt @@ -14,6 +14,13 @@ atlas deployments search indexes list List all Atlas Search indexes for a deployment. +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/docs/command/atlas-deployments-search-indexes.txt b/docs/command/atlas-deployments-search-indexes.txt index e585c945e0..31457d7c0e 100644 --- a/docs/command/atlas-deployments-search-indexes.txt +++ b/docs/command/atlas-deployments-search-indexes.txt @@ -14,6 +14,13 @@ atlas deployments search indexes Manage cloud and local search indexes. +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. + + + + + Options ------- diff --git a/docs/command/atlas-deployments-search.txt b/docs/command/atlas-deployments-search.txt index dc0b73c8b1..bcfca8d071 100644 --- a/docs/command/atlas-deployments-search.txt +++ b/docs/command/atlas-deployments-search.txt @@ -14,6 +14,13 @@ atlas deployments search Manage search for cloud and local deployments. +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. + + + + + Options ------- diff --git a/docs/command/atlas-deployments-setup.txt b/docs/command/atlas-deployments-setup.txt index b492957bb7..3aeb5a4536 100644 --- a/docs/command/atlas-deployments-setup.txt +++ b/docs/command/atlas-deployments-setup.txt @@ -14,6 +14,11 @@ atlas deployments setup Create a local deployment. +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. + + + To learn more about local atlas deployments, see https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-local/ Syntax diff --git a/docs/command/atlas-deployments-start.txt b/docs/command/atlas-deployments-start.txt index 803e81ada9..377cade0d4 100644 --- a/docs/command/atlas-deployments-start.txt +++ b/docs/command/atlas-deployments-start.txt @@ -14,6 +14,11 @@ atlas deployments start Start a deployment. +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. + + + After you stop a machine, it goes into sleep mode, or restarts. Syntax diff --git a/docs/command/atlas-deployments.txt b/docs/command/atlas-deployments.txt index fea6b69c08..e6975458d4 100644 --- a/docs/command/atlas-deployments.txt +++ b/docs/command/atlas-deployments.txt @@ -14,6 +14,13 @@ atlas deployments Manage cloud and local deployments. +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. + + + + + Options ------- diff --git a/docs/command/atlas-events-organizations-list.txt b/docs/command/atlas-events-organizations-list.txt index 86fc6039d1..7a409fdc4b 100644 --- a/docs/command/atlas-events-organizations-list.txt +++ b/docs/command/atlas-events-organizations-list.txt @@ -14,6 +14,13 @@ atlas events organizations list Return all events for the specified organization. +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/docs/command/atlas-events-organizations.txt b/docs/command/atlas-events-organizations.txt index aca25de921..b9d1601018 100644 --- a/docs/command/atlas-events-organizations.txt +++ b/docs/command/atlas-events-organizations.txt @@ -14,6 +14,11 @@ atlas events organizations Organization operations. +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. + + + List organization events. Options diff --git a/docs/command/atlas-events-projects-list.txt b/docs/command/atlas-events-projects-list.txt index 06ea1ee489..e117c106c5 100644 --- a/docs/command/atlas-events-projects-list.txt +++ b/docs/command/atlas-events-projects-list.txt @@ -14,6 +14,13 @@ atlas events projects list Return all events for the specified project. +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/docs/command/atlas-events-projects.txt b/docs/command/atlas-events-projects.txt index 1eeef0b881..8ac9f391a7 100644 --- a/docs/command/atlas-events-projects.txt +++ b/docs/command/atlas-events-projects.txt @@ -14,6 +14,11 @@ atlas events projects Project operations. +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. + + + List projects events. Options diff --git a/docs/command/atlas-events.txt b/docs/command/atlas-events.txt index 83e44e0a93..09d6aea497 100644 --- a/docs/command/atlas-events.txt +++ b/docs/command/atlas-events.txt @@ -14,6 +14,13 @@ atlas events Manage events for your organization or project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt index 849ea4f68f..4cb091bc72 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs connect Connect an Identity Provider to an Organization. +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/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt index 47ac1a50b4..8e022877e9 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs delete Delete a connected org config Organization. +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/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt index 0986820f52..8b4830223e 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs describe Describe a Connected Org Config. +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/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt index aa8916a3f1..da51de9fd9 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs disconnect Connect an Identity Provider to an Organization. +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/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt index 7093c3112f..289b13e617 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs list Describe a Connected Org Config. +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/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt index 5f4a07a49c..47025edae2 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs update Update One Org Config Connected to One Federation Setting. +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/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt index 5f21f5853f..e888100644 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings connectedOrgConfigs Manage Atlas Federated Authentication Connected Orgs Config +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. + + + + + Options ------- diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-describe.txt b/docs/command/atlas-federatedAuthentication-federationSettings-describe.txt index faa2be9d24..ddf67b05cf 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-describe.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-describe.txt @@ -14,6 +14,11 @@ atlas federatedAuthentication federationSettings describe Return the Federation Settings details for the specified organization. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization Owner role. Syntax diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt index 633761f322..880de1ea4f 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings identityProvider create oidc Create an OIDC identity provider. +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/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt index 58d31e6349..dd5cd1cb44 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings identityProvider create Create Federated Authentication Identity Providers. +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. + + + + + Options ------- diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt index c0aaad11b2..1c237b3189 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt @@ -14,6 +14,11 @@ atlas federatedAuthentication federationSettings identityProvider delete Remove the specified identity provider from your federation settings. +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. + + + To use this command, you must authenticate with a user account or an API key with the Org Owner role. Syntax diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt index 1977c6cda7..fc6d536c49 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt @@ -14,6 +14,11 @@ atlas federatedAuthentication federationSettings identityProvider describe Describe the specified identity provider from your federation settings. +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. + + + To use this command, you must authenticate with a user account or an API key with the Org Owner role. Syntax diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt index e0a92bbcd7..e359263f83 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt @@ -14,6 +14,11 @@ atlas federatedAuthentication federationSettings identityProvider list List the identity providers from your federation settings. +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. + + + To use this command, you must authenticate with a user account or an API key with the Org Owner role. Syntax diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt index 99f29fd56a..7ae06838a2 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt @@ -14,6 +14,11 @@ atlas federatedAuthentication federationSettings identityProvider revokeJwk Revoke the JWK token from the specified identity provider from your federation settings. +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. + + + To use this command, you must authenticate with a user account or an API key with the Org Owner role. Syntax diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt index 1b1ae15028..1d8e798f9e 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings identityProvider update oidc Update an OIDC identity provider. +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/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt index 9ced3f51a8..6c617f0172 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings identityProvider update Update Federated Authentication Identity Providers. +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. + + + + + Options ------- diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt index 26ea30cb0a..489fbcf667 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings identityProvider Manage Federated Authentication Identity Providers. +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. + + + + + Options ------- diff --git a/docs/command/atlas-federatedAuthentication-federationSettings.txt b/docs/command/atlas-federatedAuthentication-federationSettings.txt index 65ff2f3863..c90d028463 100644 --- a/docs/command/atlas-federatedAuthentication-federationSettings.txt +++ b/docs/command/atlas-federatedAuthentication-federationSettings.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication federationSettings Manage Atlas Federated Authentication Federation Settings +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. + + + + + Options ------- diff --git a/docs/command/atlas-federatedAuthentication.txt b/docs/command/atlas-federatedAuthentication.txt index 20e4ac2898..a07a2984f8 100644 --- a/docs/command/atlas-federatedAuthentication.txt +++ b/docs/command/atlas-federatedAuthentication.txt @@ -14,6 +14,13 @@ atlas federatedAuthentication Manage Atlas Federated Authentication. +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. + + + + + Options ------- diff --git a/docs/command/atlas-integrations-create-DATADOG.txt b/docs/command/atlas-integrations-create-DATADOG.txt index 4ff69b54d8..623e7478e9 100644 --- a/docs/command/atlas-integrations-create-DATADOG.txt +++ b/docs/command/atlas-integrations-create-DATADOG.txt @@ -14,6 +14,11 @@ atlas integrations create DATADOG Create or update a Datadog integration for your project. +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. + + + The requesting API key must have the Organization Owner or Project Owner role to configure an integration with Datadog. After you integrate with Datadog, you can send metric data about your project to your Datadog dashboard. To learn more about the metrics available to Datadog, see https://www.mongodb.com/docs/atlas/tutorial/datadog-integration/. diff --git a/docs/command/atlas-integrations-create-OPS_GENIE.txt b/docs/command/atlas-integrations-create-OPS_GENIE.txt index f379cf6c82..6a510190df 100644 --- a/docs/command/atlas-integrations-create-OPS_GENIE.txt +++ b/docs/command/atlas-integrations-create-OPS_GENIE.txt @@ -14,6 +14,11 @@ atlas integrations create OPS_GENIE Create or update an Opsgenie integration for your project. +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. + + + The requesting API key must have the Organization Owner or Project Owner role to configure an integration with Opsgenie. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-integrations-create-PAGER_DUTY.txt b/docs/command/atlas-integrations-create-PAGER_DUTY.txt index 4772a69a43..2cefcd5628 100644 --- a/docs/command/atlas-integrations-create-PAGER_DUTY.txt +++ b/docs/command/atlas-integrations-create-PAGER_DUTY.txt @@ -14,6 +14,11 @@ atlas integrations create PAGER_DUTY Create or update a PagerDuty integration for your project. +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. + + + The requesting API key must have the Organization Owner or Project Owner role to configure an integration with PagerDuty. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-integrations-create-VICTOR_OPS.txt b/docs/command/atlas-integrations-create-VICTOR_OPS.txt index 8c7bf304a2..e626922f97 100644 --- a/docs/command/atlas-integrations-create-VICTOR_OPS.txt +++ b/docs/command/atlas-integrations-create-VICTOR_OPS.txt @@ -14,6 +14,11 @@ atlas integrations create VICTOR_OPS Create or update a Splunk On-Call integration for your project. +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. + + + VictorOps is now Splunk On-Call. The requesting API key must have the Organization Owner or Project Owner role to configure an integration with Splunk On-Call. diff --git a/docs/command/atlas-integrations-create-WEBHOOK.txt b/docs/command/atlas-integrations-create-WEBHOOK.txt index 32dccd71c0..9abb2a4304 100644 --- a/docs/command/atlas-integrations-create-WEBHOOK.txt +++ b/docs/command/atlas-integrations-create-WEBHOOK.txt @@ -14,6 +14,11 @@ atlas integrations create WEBHOOK Create or update a webhook integration for your project. +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. + + + The requesting API key must have the Organization Owner or Project Owner role to configure a webhook integration. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-integrations-create.txt b/docs/command/atlas-integrations-create.txt index 85048bcdb1..5daecc739c 100644 --- a/docs/command/atlas-integrations-create.txt +++ b/docs/command/atlas-integrations-create.txt @@ -14,6 +14,13 @@ atlas integrations create Create operations. +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. + + + + + Options ------- diff --git a/docs/command/atlas-integrations-delete.txt b/docs/command/atlas-integrations-delete.txt index 63239e640e..c81f01844e 100644 --- a/docs/command/atlas-integrations-delete.txt +++ b/docs/command/atlas-integrations-delete.txt @@ -14,6 +14,11 @@ atlas integrations delete Remove the specified third-party integration from your project. +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. + + + Deleting an integration from a project removes that integration configuration only for that project. This does not affect any other project or organization's configured integrations. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-integrations-describe.txt b/docs/command/atlas-integrations-describe.txt index 8d00468824..9236f280c9 100644 --- a/docs/command/atlas-integrations-describe.txt +++ b/docs/command/atlas-integrations-describe.txt @@ -14,6 +14,11 @@ atlas integrations describe Return the details for the specified third-party integration for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-integrations-list.txt b/docs/command/atlas-integrations-list.txt index 46aefedf60..879563f7af 100644 --- a/docs/command/atlas-integrations-list.txt +++ b/docs/command/atlas-integrations-list.txt @@ -14,6 +14,11 @@ atlas integrations list Return all active third-party integrations for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-integrations.txt b/docs/command/atlas-integrations.txt index 5324838902..92ca1d1af9 100644 --- a/docs/command/atlas-integrations.txt +++ b/docs/command/atlas-integrations.txt @@ -14,6 +14,13 @@ atlas integrations Configure third-party integrations for your Atlas project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-liveMigrations-create.txt b/docs/command/atlas-liveMigrations-create.txt index dbdd664ecd..9f410ab0cc 100644 --- a/docs/command/atlas-liveMigrations-create.txt +++ b/docs/command/atlas-liveMigrations-create.txt @@ -14,6 +14,11 @@ atlas liveMigrations create Create a new push live migration. +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. + + + To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. Syntax diff --git a/docs/command/atlas-liveMigrations-cutover.txt b/docs/command/atlas-liveMigrations-cutover.txt index b52d4f9ee8..2876298183 100644 --- a/docs/command/atlas-liveMigrations-cutover.txt +++ b/docs/command/atlas-liveMigrations-cutover.txt @@ -14,6 +14,11 @@ atlas liveMigrations cutover Start the cutover for a push live migration and confirm when the cutover completes. When the cutover completes, the application completes the live migration process and stops synchronizing with the source cluster. +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. + + + To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. Syntax diff --git a/docs/command/atlas-liveMigrations-describe.txt b/docs/command/atlas-liveMigrations-describe.txt index 2798a01192..fc5c697263 100644 --- a/docs/command/atlas-liveMigrations-describe.txt +++ b/docs/command/atlas-liveMigrations-describe.txt @@ -14,6 +14,13 @@ atlas liveMigrations describe Return a push live migration job. +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/docs/command/atlas-liveMigrations-link-create.txt b/docs/command/atlas-liveMigrations-link-create.txt index e736135d52..dfdfb601a2 100644 --- a/docs/command/atlas-liveMigrations-link-create.txt +++ b/docs/command/atlas-liveMigrations-link-create.txt @@ -14,6 +14,11 @@ atlas liveMigrations link create Create a new link-token for a push live migration. +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. + + + To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. Syntax diff --git a/docs/command/atlas-liveMigrations-link-delete.txt b/docs/command/atlas-liveMigrations-link-delete.txt index 5b4573824a..e50a4af096 100644 --- a/docs/command/atlas-liveMigrations-link-delete.txt +++ b/docs/command/atlas-liveMigrations-link-delete.txt @@ -14,6 +14,13 @@ atlas liveMigrations link delete Delete one link-token. +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/docs/command/atlas-liveMigrations-link.txt b/docs/command/atlas-liveMigrations-link.txt index 7d81d1f085..04ae43d877 100644 --- a/docs/command/atlas-liveMigrations-link.txt +++ b/docs/command/atlas-liveMigrations-link.txt @@ -14,6 +14,13 @@ atlas liveMigrations link Manage the link-token for your organization. +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. + + + + + Options ------- diff --git a/docs/command/atlas-liveMigrations-validation-create.txt b/docs/command/atlas-liveMigrations-validation-create.txt index f47530b581..a427a5309a 100644 --- a/docs/command/atlas-liveMigrations-validation-create.txt +++ b/docs/command/atlas-liveMigrations-validation-create.txt @@ -14,6 +14,11 @@ atlas liveMigrations validation create Create a new validation request for a push live migration. +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. + + + To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. Syntax diff --git a/docs/command/atlas-liveMigrations-validation-describe.txt b/docs/command/atlas-liveMigrations-validation-describe.txt index 85cf8225b7..ab5baf9594 100644 --- a/docs/command/atlas-liveMigrations-validation-describe.txt +++ b/docs/command/atlas-liveMigrations-validation-describe.txt @@ -14,6 +14,13 @@ atlas liveMigrations validation describe Return one validation job. +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/docs/command/atlas-liveMigrations-validation.txt b/docs/command/atlas-liveMigrations-validation.txt index e0e174761c..da2ef7d201 100644 --- a/docs/command/atlas-liveMigrations-validation.txt +++ b/docs/command/atlas-liveMigrations-validation.txt @@ -14,6 +14,13 @@ atlas liveMigrations validation Manage a Live Migration validation job for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-liveMigrations.txt b/docs/command/atlas-liveMigrations.txt index 015e14547d..90effdf80a 100644 --- a/docs/command/atlas-liveMigrations.txt +++ b/docs/command/atlas-liveMigrations.txt @@ -14,6 +14,13 @@ atlas liveMigrations Manage a Live Migration to Atlas for your organization. +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. + + + + + Options ------- diff --git a/docs/command/atlas-logs-download.txt b/docs/command/atlas-logs-download.txt index 576714f0de..30e7b5c91d 100644 --- a/docs/command/atlas-logs-download.txt +++ b/docs/command/atlas-logs-download.txt @@ -14,6 +14,11 @@ atlas logs download Download a compressed file that contains the MongoDB logs for the specified host. +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. + + + This command downloads a file with a .gz extension. To find the hostnames for an Atlas project, use the process list command. diff --git a/docs/command/atlas-logs.txt b/docs/command/atlas-logs.txt index 36035a512e..ca910c3c48 100644 --- a/docs/command/atlas-logs.txt +++ b/docs/command/atlas-logs.txt @@ -14,6 +14,13 @@ atlas logs Download host logs for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-maintenanceWindows-clear.txt b/docs/command/atlas-maintenanceWindows-clear.txt index 300aafbd30..d268de7152 100644 --- a/docs/command/atlas-maintenanceWindows-clear.txt +++ b/docs/command/atlas-maintenanceWindows-clear.txt @@ -14,6 +14,11 @@ atlas maintenanceWindows clear Clear the current maintenance window setting for your project. +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. + + + To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-maintenanceWindows-defer.txt b/docs/command/atlas-maintenanceWindows-defer.txt index f586ce1e7e..142f73f6ca 100644 --- a/docs/command/atlas-maintenanceWindows-defer.txt +++ b/docs/command/atlas-maintenanceWindows-defer.txt @@ -14,6 +14,11 @@ atlas maintenanceWindows defer Defer scheduled maintenance for your project for one week. +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. + + + To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-maintenanceWindows-describe.txt b/docs/command/atlas-maintenanceWindows-describe.txt index 2401651d5e..7ab67f4ab9 100644 --- a/docs/command/atlas-maintenanceWindows-describe.txt +++ b/docs/command/atlas-maintenanceWindows-describe.txt @@ -14,6 +14,11 @@ atlas maintenanceWindows describe Return the maintenance window details for your project. +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. + + + To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. To use this command, you must authenticate with a user account or an API key with the Project Read Only role. diff --git a/docs/command/atlas-maintenanceWindows-update.txt b/docs/command/atlas-maintenanceWindows-update.txt index affa97dd2f..afe0e2be08 100644 --- a/docs/command/atlas-maintenanceWindows-update.txt +++ b/docs/command/atlas-maintenanceWindows-update.txt @@ -14,6 +14,11 @@ atlas maintenanceWindows update Modify the maintenance window for your project. +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. + + + To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-maintenanceWindows.txt b/docs/command/atlas-maintenanceWindows.txt index fa4ee9c2d8..d873ba6ecd 100644 --- a/docs/command/atlas-maintenanceWindows.txt +++ b/docs/command/atlas-maintenanceWindows.txt @@ -14,6 +14,13 @@ atlas maintenanceWindows Manage Atlas maintenance windows. +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. + + + + + Options ------- diff --git a/docs/command/atlas-metrics-databases-describe.txt b/docs/command/atlas-metrics-databases-describe.txt index 74def3d321..6d9ca9e037 100644 --- a/docs/command/atlas-metrics-databases-describe.txt +++ b/docs/command/atlas-metrics-databases-describe.txt @@ -14,6 +14,11 @@ atlas metrics databases describe Return the measurements of a database on the specified host. +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. + + + To return the hostname and port needed for this command, run atlas process list diff --git a/docs/command/atlas-metrics-databases-list.txt b/docs/command/atlas-metrics-databases-list.txt index b3cc899445..1be0cf3730 100644 --- a/docs/command/atlas-metrics-databases-list.txt +++ b/docs/command/atlas-metrics-databases-list.txt @@ -14,6 +14,11 @@ atlas metrics databases list Return all databases running on the specified host for your project. +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. + + + To return the hostname and port needed for this command, run atlas processes list diff --git a/docs/command/atlas-metrics-databases.txt b/docs/command/atlas-metrics-databases.txt index 2db0e1a894..83f8f80bf4 100644 --- a/docs/command/atlas-metrics-databases.txt +++ b/docs/command/atlas-metrics-databases.txt @@ -14,6 +14,13 @@ atlas metrics databases List available databases or database metrics for a given host. +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. + + + + + Options ------- diff --git a/docs/command/atlas-metrics-disks-describe.txt b/docs/command/atlas-metrics-disks-describe.txt index 3e20344122..2948833c71 100644 --- a/docs/command/atlas-metrics-disks-describe.txt +++ b/docs/command/atlas-metrics-disks-describe.txt @@ -14,6 +14,11 @@ atlas metrics disks describe Return the measurements of a disk or partition on the specified host. +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. + + + To return the hostname and port needed for this command, run atlas processes list diff --git a/docs/command/atlas-metrics-disks-list.txt b/docs/command/atlas-metrics-disks-list.txt index d541f41a04..86436a8b14 100644 --- a/docs/command/atlas-metrics-disks-list.txt +++ b/docs/command/atlas-metrics-disks-list.txt @@ -14,6 +14,11 @@ atlas metrics disks list Return all disks or disk partitions on the specified host for your project. +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. + + + To return the hostname and port needed for this command, run: $ atlas processes list diff --git a/docs/command/atlas-metrics-disks.txt b/docs/command/atlas-metrics-disks.txt index 42bd8f2120..2c0651ea72 100644 --- a/docs/command/atlas-metrics-disks.txt +++ b/docs/command/atlas-metrics-disks.txt @@ -14,6 +14,13 @@ atlas metrics disks List available disks or disk metrics for a given host. +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. + + + + + Options ------- diff --git a/docs/command/atlas-metrics-processes.txt b/docs/command/atlas-metrics-processes.txt index 9ee270bb13..6852b579cf 100644 --- a/docs/command/atlas-metrics-processes.txt +++ b/docs/command/atlas-metrics-processes.txt @@ -14,6 +14,11 @@ atlas metrics processes Return the process measurements for the specified host. +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. + + + To return the hostname and port needed for this command, run atlas processes list diff --git a/docs/command/atlas-metrics.txt b/docs/command/atlas-metrics.txt index a1c5aadc66..dad08d1cd5 100644 --- a/docs/command/atlas-metrics.txt +++ b/docs/command/atlas-metrics.txt @@ -14,6 +14,13 @@ atlas metrics Get metrics on the MongoDB process. +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. + + + + + Options ------- diff --git a/docs/command/atlas-networking-containers-delete.txt b/docs/command/atlas-networking-containers-delete.txt index 689524ce53..0eff902b03 100644 --- a/docs/command/atlas-networking-containers-delete.txt +++ b/docs/command/atlas-networking-containers-delete.txt @@ -14,6 +14,11 @@ atlas networking containers delete Remove the specified network peering container from your project before creating any clusters. Don't run this command if you have clusters in your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-networking-containers-list.txt b/docs/command/atlas-networking-containers-list.txt index a8750b67d6..26ea59bb09 100644 --- a/docs/command/atlas-networking-containers-list.txt +++ b/docs/command/atlas-networking-containers-list.txt @@ -14,6 +14,11 @@ atlas networking containers list Return all network peering containers for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-networking-containers.txt b/docs/command/atlas-networking-containers.txt index 6756369132..de3d5bd384 100644 --- a/docs/command/atlas-networking-containers.txt +++ b/docs/command/atlas-networking-containers.txt @@ -14,6 +14,13 @@ atlas networking containers Manage Network Peering containers. +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. + + + + + Options ------- diff --git a/docs/command/atlas-networking-peering-create-aws.txt b/docs/command/atlas-networking-peering-create-aws.txt index 111a3de4cc..9190d9e722 100644 --- a/docs/command/atlas-networking-peering-create-aws.txt +++ b/docs/command/atlas-networking-peering-create-aws.txt @@ -14,6 +14,11 @@ atlas networking peering create aws Create a network peering connection between the Atlas VPC and your AWS VPC. +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. + + + The network peering create command checks if a VPC exists in the region you specify for your Atlas project. If one exists, this command creates the peering connection between that VPC and your VPC. If an Atlas VPC doesn't exist, this command creates one and creates a connection between it and your VPC. To learn more about network peering connections, see https://www.mongodb.com/docs/atlas/security-vpc-peering/. diff --git a/docs/command/atlas-networking-peering-create-azure.txt b/docs/command/atlas-networking-peering-create-azure.txt index 714d7b51a0..6376ab7a2b 100644 --- a/docs/command/atlas-networking-peering-create-azure.txt +++ b/docs/command/atlas-networking-peering-create-azure.txt @@ -14,6 +14,11 @@ atlas networking peering create azure Create a network peering connection between the Atlas VPC and your Azure VNet. +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. + + + Before you create an Azure network peering connection, complete the prerequisites listed here: https://www.mongodb.com/docs/atlas/reference/api/vpc-create-peering-connection/#prerequisites. The network peering create command checks if a VNet exists in the region you specify for your Atlas project. If one exists, this command creates the peering connection between that VNet and your VPC. If an Atlas VPC does not exist, this command creates one and creates a connection between it and your VNet. diff --git a/docs/command/atlas-networking-peering-create-gcp.txt b/docs/command/atlas-networking-peering-create-gcp.txt index 6110e4fcd2..e8428e69db 100644 --- a/docs/command/atlas-networking-peering-create-gcp.txt +++ b/docs/command/atlas-networking-peering-create-gcp.txt @@ -14,6 +14,11 @@ atlas networking peering create gcp Create a network peering connection between the Atlas VPC and your Google Cloud VPC. +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. + + + The network peering create command checks if a VPC exists in the region you specify for your Atlas project. If one exists, this command creates the peering connection between that VPC and your VPC. If an Atlas VPC doesn't exist, this command creates one and creates a connection between it and your VPC. To learn more about network peering connections, see https://www.mongodb.com/docs/atlas/security-vpc-peering/. diff --git a/docs/command/atlas-networking-peering-create.txt b/docs/command/atlas-networking-peering-create.txt index fbe947b7b4..95c2a81eee 100644 --- a/docs/command/atlas-networking-peering-create.txt +++ b/docs/command/atlas-networking-peering-create.txt @@ -14,6 +14,13 @@ atlas networking peering create Create a connection with AWS, Azure and Google Cloud. +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. + + + + + Options ------- diff --git a/docs/command/atlas-networking-peering-delete.txt b/docs/command/atlas-networking-peering-delete.txt index ec44e2d033..44a6c65e4f 100644 --- a/docs/command/atlas-networking-peering-delete.txt +++ b/docs/command/atlas-networking-peering-delete.txt @@ -14,6 +14,11 @@ atlas networking peering delete Remove the specified peering connection from your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-networking-peering-list.txt b/docs/command/atlas-networking-peering-list.txt index e47c6e0848..97fa456c28 100644 --- a/docs/command/atlas-networking-peering-list.txt +++ b/docs/command/atlas-networking-peering-list.txt @@ -14,6 +14,11 @@ atlas networking peering list Return the details for all network peering connections for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-networking-peering-watch.txt b/docs/command/atlas-networking-peering-watch.txt index 7c8e3ec7af..25b55ff492 100644 --- a/docs/command/atlas-networking-peering-watch.txt +++ b/docs/command/atlas-networking-peering-watch.txt @@ -14,6 +14,11 @@ atlas networking peering watch Watch the specified peering connection in your project until it becomes available. +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. + + + This command checks the peering connection's status periodically until it becomes available. Once it reaches the expected state, the command prints "Network peering changes completed." If you run the command in the terminal, it blocks the terminal session until the resource is available. diff --git a/docs/command/atlas-networking-peering.txt b/docs/command/atlas-networking-peering.txt index fdeb3a8f5f..687e0a1cf5 100644 --- a/docs/command/atlas-networking-peering.txt +++ b/docs/command/atlas-networking-peering.txt @@ -14,6 +14,13 @@ atlas networking peering Manage Network Peering connections. +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. + + + + + Options ------- diff --git a/docs/command/atlas-networking.txt b/docs/command/atlas-networking.txt index e98acb29b2..6ee3e6788c 100644 --- a/docs/command/atlas-networking.txt +++ b/docs/command/atlas-networking.txt @@ -14,6 +14,13 @@ atlas networking Manage or configure network peering for your Atlas project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-organizations-apiKeys-accessLists-create.txt b/docs/command/atlas-organizations-apiKeys-accessLists-create.txt index 7ba279eced..a039b3524c 100644 --- a/docs/command/atlas-organizations-apiKeys-accessLists-create.txt +++ b/docs/command/atlas-organizations-apiKeys-accessLists-create.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys accessLists create Create an IP access list entry for your API Key. +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. + + + To view possible values for the apiKey option, run atlas organizations apiKeys list. To use this command, you must authenticate with a user account or an API key with the Read Write role. diff --git a/docs/command/atlas-organizations-apiKeys-accessLists-delete.txt b/docs/command/atlas-organizations-apiKeys-accessLists-delete.txt index 76735790d6..5a81d55149 100644 --- a/docs/command/atlas-organizations-apiKeys-accessLists-delete.txt +++ b/docs/command/atlas-organizations-apiKeys-accessLists-delete.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys accessLists delete Remove the specified IP access list entry from your API Key. +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. + + + To use this command, you must authenticate with a user account or an API key with the Read Write role. Syntax diff --git a/docs/command/atlas-organizations-apiKeys-accessLists-list.txt b/docs/command/atlas-organizations-apiKeys-accessLists-list.txt index b18ee729a7..d255724bb9 100644 --- a/docs/command/atlas-organizations-apiKeys-accessLists-list.txt +++ b/docs/command/atlas-organizations-apiKeys-accessLists-list.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys accessLists list Return all IP access list entries for your API Key. +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. + + + To view possible values for the apiKeyID argument, run atlas organizations apiKeys list. To use this command, you must authenticate with a user account or an API key with the Organization Member role. diff --git a/docs/command/atlas-organizations-apiKeys-accessLists.txt b/docs/command/atlas-organizations-apiKeys-accessLists.txt index 93b1ff2009..e7d543fdf9 100644 --- a/docs/command/atlas-organizations-apiKeys-accessLists.txt +++ b/docs/command/atlas-organizations-apiKeys-accessLists.txt @@ -14,6 +14,13 @@ atlas organizations apiKeys accessLists Manage the IP access list for your API Key. +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. + + + + + Options ------- diff --git a/docs/command/atlas-organizations-apiKeys-assign.txt b/docs/command/atlas-organizations-apiKeys-assign.txt index 9842e8951a..554977aaf8 100644 --- a/docs/command/atlas-organizations-apiKeys-assign.txt +++ b/docs/command/atlas-organizations-apiKeys-assign.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys assign Modify the roles or description for the specified organization API key. +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. + + + When you modify the roles for an organization API key with this command, the values you specify overwrite the existing roles assigned to the API key. To view possible values for the apiKeyId argument, run atlas organizations apiKeys list. diff --git a/docs/command/atlas-organizations-apiKeys-create.txt b/docs/command/atlas-organizations-apiKeys-create.txt index c285d2e91c..31883a7189 100644 --- a/docs/command/atlas-organizations-apiKeys-create.txt +++ b/docs/command/atlas-organizations-apiKeys-create.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys create Create an API Key for your organization. +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. + + + MongoDB returns the private API key only once. After you run this command, immediately copy, save, and secure both the public and private API keys. To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. diff --git a/docs/command/atlas-organizations-apiKeys-delete.txt b/docs/command/atlas-organizations-apiKeys-delete.txt index 37edd780fe..f3595e7fb2 100644 --- a/docs/command/atlas-organizations-apiKeys-delete.txt +++ b/docs/command/atlas-organizations-apiKeys-delete.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys delete Remove the specified API key for your organization. +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. + + + To view possible values for the ID argument, run atlas organizations apiKeys list. To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. diff --git a/docs/command/atlas-organizations-apiKeys-describe.txt b/docs/command/atlas-organizations-apiKeys-describe.txt index 19b24d2cd3..ab7980d2ee 100644 --- a/docs/command/atlas-organizations-apiKeys-describe.txt +++ b/docs/command/atlas-organizations-apiKeys-describe.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys describe Return the details for the specified API key for your organization. +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. + + + To view possible values for the ID argument, run atlas organizations apiKeys list. To use this command, you must authenticate with a user account or an API key with the Organization Member role. diff --git a/docs/command/atlas-organizations-apiKeys-list.txt b/docs/command/atlas-organizations-apiKeys-list.txt index 5c6d5e5410..e812666638 100644 --- a/docs/command/atlas-organizations-apiKeys-list.txt +++ b/docs/command/atlas-organizations-apiKeys-list.txt @@ -14,6 +14,11 @@ atlas organizations apiKeys list Return all API keys for your organization. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/docs/command/atlas-organizations-apiKeys.txt b/docs/command/atlas-organizations-apiKeys.txt index d4af319a1e..be40b45439 100644 --- a/docs/command/atlas-organizations-apiKeys.txt +++ b/docs/command/atlas-organizations-apiKeys.txt @@ -14,6 +14,13 @@ atlas organizations apiKeys Organization API Keys operations. +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. + + + + + Options ------- diff --git a/docs/command/atlas-organizations-create.txt b/docs/command/atlas-organizations-create.txt index e9fc7d21c3..0d798f85c2 100644 --- a/docs/command/atlas-organizations-create.txt +++ b/docs/command/atlas-organizations-create.txt @@ -14,6 +14,11 @@ atlas organizations create Create an organization. +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. + + + When authenticating using API keys, the organization to which the API keys belong must have cross-organization billing enabled. The resulting org will be linked to the paying org. Syntax diff --git a/docs/command/atlas-organizations-delete.txt b/docs/command/atlas-organizations-delete.txt index 1f6a6afc13..3fe1adae7a 100644 --- a/docs/command/atlas-organizations-delete.txt +++ b/docs/command/atlas-organizations-delete.txt @@ -14,6 +14,11 @@ atlas organizations delete Remove the specified organization. +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. + + + Organizations with active projects can't be removed. To use this command, you must authenticate with a user account or an API key with the Organization Owner role. diff --git a/docs/command/atlas-organizations-describe.txt b/docs/command/atlas-organizations-describe.txt index 52b0e108ea..722ee41300 100644 --- a/docs/command/atlas-organizations-describe.txt +++ b/docs/command/atlas-organizations-describe.txt @@ -14,6 +14,11 @@ atlas organizations describe Return the details for the specified organizations. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/docs/command/atlas-organizations-invitations-delete.txt b/docs/command/atlas-organizations-invitations-delete.txt index ebd795ec8b..934847c776 100644 --- a/docs/command/atlas-organizations-invitations-delete.txt +++ b/docs/command/atlas-organizations-invitations-delete.txt @@ -14,6 +14,11 @@ atlas organizations invitations delete Remove the specified pending invitation to your organization. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. Syntax diff --git a/docs/command/atlas-organizations-invitations-describe.txt b/docs/command/atlas-organizations-invitations-describe.txt index c842a75fb8..f261f57b55 100644 --- a/docs/command/atlas-organizations-invitations-describe.txt +++ b/docs/command/atlas-organizations-invitations-describe.txt @@ -14,6 +14,11 @@ atlas organizations invitations describe Return the details for the specified pending invitation to your organization. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. Syntax diff --git a/docs/command/atlas-organizations-invitations-invite.txt b/docs/command/atlas-organizations-invitations-invite.txt index d62a0a92f9..34a17c3d61 100644 --- a/docs/command/atlas-organizations-invitations-invite.txt +++ b/docs/command/atlas-organizations-invitations-invite.txt @@ -14,6 +14,11 @@ atlas organizations invitations invite Invite the specified MongoDB user to your organization. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. Syntax diff --git a/docs/command/atlas-organizations-invitations-list.txt b/docs/command/atlas-organizations-invitations-list.txt index 074015dd98..4f48a09255 100644 --- a/docs/command/atlas-organizations-invitations-list.txt +++ b/docs/command/atlas-organizations-invitations-list.txt @@ -14,6 +14,11 @@ atlas organizations invitations list Return all pending invitations to your organization. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. Syntax diff --git a/docs/command/atlas-organizations-invitations-update.txt b/docs/command/atlas-organizations-invitations-update.txt index 446dcf4ff0..74e04f0250 100644 --- a/docs/command/atlas-organizations-invitations-update.txt +++ b/docs/command/atlas-organizations-invitations-update.txt @@ -14,6 +14,11 @@ atlas organizations invitations update Modifies the details of the specified pending invitation to your organization. +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. + + + You can use either the invitation ID or the user's email address to specify the invitation. To use this command, you must authenticate with a user account or an API key with the Organization Owner role. diff --git a/docs/command/atlas-organizations-invitations.txt b/docs/command/atlas-organizations-invitations.txt index 0135c98693..c0e1dfe05a 100644 --- a/docs/command/atlas-organizations-invitations.txt +++ b/docs/command/atlas-organizations-invitations.txt @@ -14,6 +14,11 @@ atlas organizations invitations Invitation operations. +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. + + + Create, list and manage your MongoDB organization invites. Options diff --git a/docs/command/atlas-organizations-list.txt b/docs/command/atlas-organizations-list.txt index 5248147670..76f481fe96 100644 --- a/docs/command/atlas-organizations-list.txt +++ b/docs/command/atlas-organizations-list.txt @@ -14,6 +14,11 @@ atlas organizations list Return all organizations. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/docs/command/atlas-organizations-users-list.txt b/docs/command/atlas-organizations-users-list.txt index 94299faa64..2cc14d066f 100644 --- a/docs/command/atlas-organizations-users-list.txt +++ b/docs/command/atlas-organizations-users-list.txt @@ -14,6 +14,11 @@ atlas organizations users list Return all users for an organization. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/docs/command/atlas-organizations-users.txt b/docs/command/atlas-organizations-users.txt index 928a8825e1..e0319afe16 100644 --- a/docs/command/atlas-organizations-users.txt +++ b/docs/command/atlas-organizations-users.txt @@ -14,6 +14,13 @@ atlas organizations users Manage your Atlas users. +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. + + + + + Options ------- diff --git a/docs/command/atlas-organizations.txt b/docs/command/atlas-organizations.txt index fa2ee1e599..b6c694c2fb 100644 --- a/docs/command/atlas-organizations.txt +++ b/docs/command/atlas-organizations.txt @@ -14,6 +14,11 @@ atlas organizations Manage your Atlas organizations. +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. + + + Create, list and manage your MongoDB organizations. Options diff --git a/docs/command/atlas-performanceAdvisor-namespaces-list.txt b/docs/command/atlas-performanceAdvisor-namespaces-list.txt index 19b5659d0d..ec9bb3ac8e 100644 --- a/docs/command/atlas-performanceAdvisor-namespaces-list.txt +++ b/docs/command/atlas-performanceAdvisor-namespaces-list.txt @@ -14,6 +14,11 @@ atlas performanceAdvisor namespaces list Return up to 20 namespaces for collections experiencing slow queries on the specified host. +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. + + + Namespaces appear in the following format: {database}.{collection}. If you don't set the duration option or the since option, this command returns data from the last 24 hours. diff --git a/docs/command/atlas-performanceAdvisor-namespaces.txt b/docs/command/atlas-performanceAdvisor-namespaces.txt index e05970fbc6..34190e7c8d 100644 --- a/docs/command/atlas-performanceAdvisor-namespaces.txt +++ b/docs/command/atlas-performanceAdvisor-namespaces.txt @@ -14,6 +14,13 @@ atlas performanceAdvisor namespaces Retrieve namespaces for collections experiencing slow queries +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. + + + + + Options ------- diff --git a/docs/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt b/docs/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt index 09b64bb4cf..92f48a8714 100644 --- a/docs/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt +++ b/docs/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt @@ -14,6 +14,11 @@ atlas performanceAdvisor slowOperationThreshold disable Disable the application-managed slow operation threshold for your project. +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. + + + The slow operation threshold determines which operations are flagged by the Performance Advisor and Query Profiler. When disabled, the application considers any operation that takes longer than 100 milliseconds to be slow. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt b/docs/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt index c47613c480..5b7d9adf3d 100644 --- a/docs/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt +++ b/docs/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt @@ -14,6 +14,11 @@ atlas performanceAdvisor slowOperationThreshold enable Enable the application-managed slow operation threshold for your project. +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. + + + The slow operation threshold determines which operations are flagged by the Performance Advisor and Query Profiler. When enabled, the application 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. Application-managed slow operation threshold is enabled by default for dedicated clusters (M10+). To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-performanceAdvisor-slowOperationThreshold.txt b/docs/command/atlas-performanceAdvisor-slowOperationThreshold.txt index a5ad1e3e3e..dfb91ea603 100644 --- a/docs/command/atlas-performanceAdvisor-slowOperationThreshold.txt +++ b/docs/command/atlas-performanceAdvisor-slowOperationThreshold.txt @@ -14,6 +14,13 @@ atlas performanceAdvisor slowOperationThreshold Enable or disable management of the slow operation threshold for your cluster. +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. + + + + + Options ------- diff --git a/docs/command/atlas-performanceAdvisor-slowQueryLogs-list.txt b/docs/command/atlas-performanceAdvisor-slowQueryLogs-list.txt index 52ad8c405e..a8bd30ec0d 100644 --- a/docs/command/atlas-performanceAdvisor-slowQueryLogs-list.txt +++ b/docs/command/atlas-performanceAdvisor-slowQueryLogs-list.txt @@ -14,6 +14,11 @@ atlas performanceAdvisor slowQueryLogs list Return log lines for slow queries that the Performance Advisor and Query Profiler identified. +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. + + + The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. The threshold for slow queries varies based on the average time of operations on your cluster to provide recommendations pertinent to your workload. If you don't set the duration option or the since option, this command returns data from the last 24 hours. diff --git a/docs/command/atlas-performanceAdvisor-slowQueryLogs.txt b/docs/command/atlas-performanceAdvisor-slowQueryLogs.txt index 55a1fb2c0d..ba09f494d5 100644 --- a/docs/command/atlas-performanceAdvisor-slowQueryLogs.txt +++ b/docs/command/atlas-performanceAdvisor-slowQueryLogs.txt @@ -14,6 +14,13 @@ atlas performanceAdvisor slowQueryLogs Get log lines for slow queries for a specified host +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. + + + + + Options ------- diff --git a/docs/command/atlas-performanceAdvisor-suggestedIndexes-list.txt b/docs/command/atlas-performanceAdvisor-suggestedIndexes-list.txt index bcf0b527fd..e022efb786 100644 --- a/docs/command/atlas-performanceAdvisor-suggestedIndexes-list.txt +++ b/docs/command/atlas-performanceAdvisor-suggestedIndexes-list.txt @@ -14,6 +14,11 @@ atlas performanceAdvisor suggestedIndexes list Return the suggested indexes for collections experiencing slow queries. +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. + + + The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this command, you must authenticate with a user account or an API key with the Project Read Only role. diff --git a/docs/command/atlas-performanceAdvisor-suggestedIndexes.txt b/docs/command/atlas-performanceAdvisor-suggestedIndexes.txt index b765cf2ebd..76a3635b45 100644 --- a/docs/command/atlas-performanceAdvisor-suggestedIndexes.txt +++ b/docs/command/atlas-performanceAdvisor-suggestedIndexes.txt @@ -14,6 +14,13 @@ atlas performanceAdvisor suggestedIndexes Get suggested indexes for collections experiencing slow queries +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. + + + + + Options ------- diff --git a/docs/command/atlas-performanceAdvisor.txt b/docs/command/atlas-performanceAdvisor.txt index 4428b2f1ea..7549addd09 100644 --- a/docs/command/atlas-performanceAdvisor.txt +++ b/docs/command/atlas-performanceAdvisor.txt @@ -14,6 +14,13 @@ atlas performanceAdvisor Learn more about slow queries and get suggestions to improve database performance. +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. + + + + + Options ------- diff --git a/docs/command/atlas-plugin-install.txt b/docs/command/atlas-plugin-install.txt index fa57e08fbc..507ada6b59 100644 --- a/docs/command/atlas-plugin-install.txt +++ b/docs/command/atlas-plugin-install.txt @@ -14,6 +14,11 @@ atlas plugin install Install Atlas CLI plugin from a GitHub repository. +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. + + + Install an Atlas CLI plugin from a GitHub repository. You can specify a GitHub repository using either the "/" format or a full URL. When you install the plugin, its latest release on GitHub is used by default. diff --git a/docs/command/atlas-plugin-list.txt b/docs/command/atlas-plugin-list.txt index eced103a63..15389bf918 100644 --- a/docs/command/atlas-plugin-list.txt +++ b/docs/command/atlas-plugin-list.txt @@ -14,6 +14,13 @@ atlas plugin list Returns a list of all installed plugins. +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/docs/command/atlas-plugin-uninstall.txt b/docs/command/atlas-plugin-uninstall.txt index 6117d6b567..4bd502c1fc 100644 --- a/docs/command/atlas-plugin-uninstall.txt +++ b/docs/command/atlas-plugin-uninstall.txt @@ -14,6 +14,11 @@ atlas plugin uninstall Uninstall Atlas CLI plugin. +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. + + + Uninstall an Atlas CLI plugin. You can specify a plugin to uninstall using either the "/" format or the plugin name. diff --git a/docs/command/atlas-plugin-update.txt b/docs/command/atlas-plugin-update.txt index e91b656145..2c836adde9 100644 --- a/docs/command/atlas-plugin-update.txt +++ b/docs/command/atlas-plugin-update.txt @@ -14,6 +14,11 @@ atlas plugin update Update Atlas CLI plugin. +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. + + + Update an Atlas CLI plugin. You can specify a plugin to update using either the "/" format or the plugin name. Additionally, you can use the "--all" flag to update all plugins. diff --git a/docs/command/atlas-plugin.txt b/docs/command/atlas-plugin.txt index c3c489f453..cde9a89012 100644 --- a/docs/command/atlas-plugin.txt +++ b/docs/command/atlas-plugin.txt @@ -14,6 +14,13 @@ atlas plugin Manage plugins for the AtlasCLI. +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. + + + + + Options ------- diff --git a/docs/command/atlas-privateEndpoints-aws-create.txt b/docs/command/atlas-privateEndpoints-aws-create.txt index 3dc0a82304..dc8508e098 100644 --- a/docs/command/atlas-privateEndpoints-aws-create.txt +++ b/docs/command/atlas-privateEndpoints-aws-create.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws create Create a new AWS private endpoint for your project. +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. + + + To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-privateEndpoints-aws-delete.txt b/docs/command/atlas-privateEndpoints-aws-delete.txt index 99afb3ecc3..eb5e8b8224 100644 --- a/docs/command/atlas-privateEndpoints-aws-delete.txt +++ b/docs/command/atlas-privateEndpoints-aws-delete.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws delete Remove the specified AWS private endpoint from your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-privateEndpoints-aws-describe.txt b/docs/command/atlas-privateEndpoints-aws-describe.txt index 73d6bc46c0..9817400dcd 100644 --- a/docs/command/atlas-privateEndpoints-aws-describe.txt +++ b/docs/command/atlas-privateEndpoints-aws-describe.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws describe Return the details for the specified AWS private endpoints for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-privateEndpoints-aws-interfaces-create.txt b/docs/command/atlas-privateEndpoints-aws-interfaces-create.txt index fcaeafe85a..02ca7211fb 100644 --- a/docs/command/atlas-privateEndpoints-aws-interfaces-create.txt +++ b/docs/command/atlas-privateEndpoints-aws-interfaces-create.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws interfaces create Create a new interface for the specified AWS private endpoint. +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. + + + To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-privateEndpoints-aws-interfaces-delete.txt b/docs/command/atlas-privateEndpoints-aws-interfaces-delete.txt index 11f4b27f9e..c68c1aa2a4 100644 --- a/docs/command/atlas-privateEndpoints-aws-interfaces-delete.txt +++ b/docs/command/atlas-privateEndpoints-aws-interfaces-delete.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws interfaces delete Remove the specified AWS private endpoint interface and related service from your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-privateEndpoints-aws-interfaces-describe.txt b/docs/command/atlas-privateEndpoints-aws-interfaces-describe.txt index 4c42cf4c27..48c3251044 100644 --- a/docs/command/atlas-privateEndpoints-aws-interfaces-describe.txt +++ b/docs/command/atlas-privateEndpoints-aws-interfaces-describe.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws interfaces describe Return the details for the specified AWS private endpoint interface for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-privateEndpoints-aws-interfaces.txt b/docs/command/atlas-privateEndpoints-aws-interfaces.txt index eefb55825a..8f34b38118 100644 --- a/docs/command/atlas-privateEndpoints-aws-interfaces.txt +++ b/docs/command/atlas-privateEndpoints-aws-interfaces.txt @@ -14,6 +14,13 @@ atlas privateEndpoints aws interfaces Manage Atlas AWS private endpoint interfaces. +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. + + + + + Options ------- diff --git a/docs/command/atlas-privateEndpoints-aws-list.txt b/docs/command/atlas-privateEndpoints-aws-list.txt index d73ffa7d70..bb582ae1bb 100644 --- a/docs/command/atlas-privateEndpoints-aws-list.txt +++ b/docs/command/atlas-privateEndpoints-aws-list.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws list Return all AWS private endpoints for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-privateEndpoints-aws-watch.txt b/docs/command/atlas-privateEndpoints-aws-watch.txt index 2882272d4d..c033fc5d11 100644 --- a/docs/command/atlas-privateEndpoints-aws-watch.txt +++ b/docs/command/atlas-privateEndpoints-aws-watch.txt @@ -14,6 +14,11 @@ atlas privateEndpoints aws watch Watch the specified AWS private endpoint in your project until it becomes available. +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. + + + This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. Once the endpoint reaches the expected state, the command prints "Private endpoint changes completed." If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. diff --git a/docs/command/atlas-privateEndpoints-aws.txt b/docs/command/atlas-privateEndpoints-aws.txt index d761c7a4ed..9660c5efee 100644 --- a/docs/command/atlas-privateEndpoints-aws.txt +++ b/docs/command/atlas-privateEndpoints-aws.txt @@ -14,6 +14,13 @@ atlas privateEndpoints aws Manage AWS Private Endpoints. +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. + + + + + Options ------- diff --git a/docs/command/atlas-privateEndpoints-azure-create.txt b/docs/command/atlas-privateEndpoints-azure-create.txt index 70c1bb7a91..2e6073982e 100644 --- a/docs/command/atlas-privateEndpoints-azure-create.txt +++ b/docs/command/atlas-privateEndpoints-azure-create.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure create Create a new Azure private endpoint for your project. +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. + + + To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-privateEndpoints-azure-delete.txt b/docs/command/atlas-privateEndpoints-azure-delete.txt index d450ade535..868f482387 100644 --- a/docs/command/atlas-privateEndpoints-azure-delete.txt +++ b/docs/command/atlas-privateEndpoints-azure-delete.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure delete Remove the specified Azure private endpoint from your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-privateEndpoints-azure-describe.txt b/docs/command/atlas-privateEndpoints-azure-describe.txt index 08ea40362d..2c0d1076fa 100644 --- a/docs/command/atlas-privateEndpoints-azure-describe.txt +++ b/docs/command/atlas-privateEndpoints-azure-describe.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure describe Return the details for the specified Azure private endpoint for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-privateEndpoints-azure-interfaces-create.txt b/docs/command/atlas-privateEndpoints-azure-interfaces-create.txt index 78aaaa4164..c497a4163a 100644 --- a/docs/command/atlas-privateEndpoints-azure-interfaces-create.txt +++ b/docs/command/atlas-privateEndpoints-azure-interfaces-create.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure interfaces create Create a new interface for the specified Azure private endpoint. +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. + + + To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-privateEndpoints-azure-interfaces-delete.txt b/docs/command/atlas-privateEndpoints-azure-interfaces-delete.txt index f09ff091c7..151746a489 100644 --- a/docs/command/atlas-privateEndpoints-azure-interfaces-delete.txt +++ b/docs/command/atlas-privateEndpoints-azure-interfaces-delete.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure interfaces delete Remove the specified Azure private endpoint interface and related service from your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-privateEndpoints-azure-interfaces-describe.txt b/docs/command/atlas-privateEndpoints-azure-interfaces-describe.txt index bd17506aa5..ff5cfdfb77 100644 --- a/docs/command/atlas-privateEndpoints-azure-interfaces-describe.txt +++ b/docs/command/atlas-privateEndpoints-azure-interfaces-describe.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure interfaces describe Return the details for the specified Azure private endpoint interface for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-privateEndpoints-azure-interfaces.txt b/docs/command/atlas-privateEndpoints-azure-interfaces.txt index 937d2aacae..952c255d3a 100644 --- a/docs/command/atlas-privateEndpoints-azure-interfaces.txt +++ b/docs/command/atlas-privateEndpoints-azure-interfaces.txt @@ -14,6 +14,13 @@ atlas privateEndpoints azure interfaces Manage Atlas Azure private endpoint interfaces. +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. + + + + + Options ------- diff --git a/docs/command/atlas-privateEndpoints-azure-list.txt b/docs/command/atlas-privateEndpoints-azure-list.txt index 3564976b5a..096d98ab5d 100644 --- a/docs/command/atlas-privateEndpoints-azure-list.txt +++ b/docs/command/atlas-privateEndpoints-azure-list.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure list Return all Azure private endpoints for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-privateEndpoints-azure-watch.txt b/docs/command/atlas-privateEndpoints-azure-watch.txt index fa8ad3dec8..e0005181fe 100644 --- a/docs/command/atlas-privateEndpoints-azure-watch.txt +++ b/docs/command/atlas-privateEndpoints-azure-watch.txt @@ -14,6 +14,11 @@ atlas privateEndpoints azure watch Watch the specified Azure private endpoint in your project until it becomes available. +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. + + + This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. Once the endpoint reaches the expected state, the command prints "Private endpoint changes completed." If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. diff --git a/docs/command/atlas-privateEndpoints-azure.txt b/docs/command/atlas-privateEndpoints-azure.txt index 23b7368dd2..e73eb1180f 100644 --- a/docs/command/atlas-privateEndpoints-azure.txt +++ b/docs/command/atlas-privateEndpoints-azure.txt @@ -14,6 +14,13 @@ atlas privateEndpoints azure Manage Azure Private Endpoints. +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. + + + + + Options ------- diff --git a/docs/command/atlas-privateEndpoints-gcp-create.txt b/docs/command/atlas-privateEndpoints-gcp-create.txt index 9da00080e5..5aa8f02709 100644 --- a/docs/command/atlas-privateEndpoints-gcp-create.txt +++ b/docs/command/atlas-privateEndpoints-gcp-create.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp create Create a new GCP private endpoint for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-privateEndpoints-gcp-delete.txt b/docs/command/atlas-privateEndpoints-gcp-delete.txt index a9f0a42728..6500572f82 100644 --- a/docs/command/atlas-privateEndpoints-gcp-delete.txt +++ b/docs/command/atlas-privateEndpoints-gcp-delete.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp delete Delete a GCP private endpoint for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-privateEndpoints-gcp-describe.txt b/docs/command/atlas-privateEndpoints-gcp-describe.txt index aa00926e04..a699afa0b0 100644 --- a/docs/command/atlas-privateEndpoints-gcp-describe.txt +++ b/docs/command/atlas-privateEndpoints-gcp-describe.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp describe Return a specific GCP private endpoint for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-privateEndpoints-gcp-interfaces-create.txt b/docs/command/atlas-privateEndpoints-gcp-interfaces-create.txt index c88a72796d..9d2f76941d 100644 --- a/docs/command/atlas-privateEndpoints-gcp-interfaces-create.txt +++ b/docs/command/atlas-privateEndpoints-gcp-interfaces-create.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp interfaces create Create a GCP private endpoint interface. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-privateEndpoints-gcp-interfaces-delete.txt b/docs/command/atlas-privateEndpoints-gcp-interfaces-delete.txt index f9513ead7f..a91ae03d8d 100644 --- a/docs/command/atlas-privateEndpoints-gcp-interfaces-delete.txt +++ b/docs/command/atlas-privateEndpoints-gcp-interfaces-delete.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp interfaces delete Delete a specific GCP private endpoint interface for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-privateEndpoints-gcp-interfaces-describe.txt b/docs/command/atlas-privateEndpoints-gcp-interfaces-describe.txt index db04731d9a..a938051cb9 100644 --- a/docs/command/atlas-privateEndpoints-gcp-interfaces-describe.txt +++ b/docs/command/atlas-privateEndpoints-gcp-interfaces-describe.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp interfaces describe Return a specific GCP private endpoint interface for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-privateEndpoints-gcp-interfaces.txt b/docs/command/atlas-privateEndpoints-gcp-interfaces.txt index ec3ec345fc..828182a74b 100644 --- a/docs/command/atlas-privateEndpoints-gcp-interfaces.txt +++ b/docs/command/atlas-privateEndpoints-gcp-interfaces.txt @@ -14,6 +14,13 @@ atlas privateEndpoints gcp interfaces Manage Atlas GCP private endpoint interfaces. +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. + + + + + Options ------- diff --git a/docs/command/atlas-privateEndpoints-gcp-list.txt b/docs/command/atlas-privateEndpoints-gcp-list.txt index 26f48fd754..bb887d3c57 100644 --- a/docs/command/atlas-privateEndpoints-gcp-list.txt +++ b/docs/command/atlas-privateEndpoints-gcp-list.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp list List GCP private endpoints for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-privateEndpoints-gcp-watch.txt b/docs/command/atlas-privateEndpoints-gcp-watch.txt index 5741d695f6..1fbb0b800a 100644 --- a/docs/command/atlas-privateEndpoints-gcp-watch.txt +++ b/docs/command/atlas-privateEndpoints-gcp-watch.txt @@ -14,6 +14,11 @@ atlas privateEndpoints gcp watch Watch the specified GCP private endpoint to detect changes in the endpoint's state. +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. + + + This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. Once the endpoint reaches the expected state, the command prints "GCP Private endpoint changes completed." If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. diff --git a/docs/command/atlas-privateEndpoints-gcp.txt b/docs/command/atlas-privateEndpoints-gcp.txt index 29405adf0f..5f4d56f2eb 100644 --- a/docs/command/atlas-privateEndpoints-gcp.txt +++ b/docs/command/atlas-privateEndpoints-gcp.txt @@ -14,6 +14,13 @@ atlas privateEndpoints gcp Manage GCP private endpoints. +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. + + + + + Options ------- diff --git a/docs/command/atlas-privateEndpoints-regionalModes-describe.txt b/docs/command/atlas-privateEndpoints-regionalModes-describe.txt index f378aad693..be827fafd9 100644 --- a/docs/command/atlas-privateEndpoints-regionalModes-describe.txt +++ b/docs/command/atlas-privateEndpoints-regionalModes-describe.txt @@ -14,6 +14,11 @@ atlas privateEndpoints regionalModes describe Return the regionalized private endpoint setting for your project. +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. + + + Use this command to check whether you can create multiple private resources per region. To use this command, you must authenticate with a user account or an API key with the Project Read Only role. diff --git a/docs/command/atlas-privateEndpoints-regionalModes-disable.txt b/docs/command/atlas-privateEndpoints-regionalModes-disable.txt index 22b38a3e8b..0b0f0f65ef 100644 --- a/docs/command/atlas-privateEndpoints-regionalModes-disable.txt +++ b/docs/command/atlas-privateEndpoints-regionalModes-disable.txt @@ -14,6 +14,11 @@ atlas privateEndpoints regionalModes disable Disable the regionalized private endpoint setting for your project. +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. + + + This disables the ability to create multiple private resources per region in all cloud service providers for this project. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-privateEndpoints-regionalModes-enable.txt b/docs/command/atlas-privateEndpoints-regionalModes-enable.txt index e7caddbbe0..667c08260c 100644 --- a/docs/command/atlas-privateEndpoints-regionalModes-enable.txt +++ b/docs/command/atlas-privateEndpoints-regionalModes-enable.txt @@ -14,6 +14,11 @@ atlas privateEndpoints regionalModes enable Enable the regionalized private endpoint setting for your project. +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. + + + This enables the ability to create multiple private resources per region in all cloud service providers for this project. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-privateEndpoints-regionalModes.txt b/docs/command/atlas-privateEndpoints-regionalModes.txt index 87c8064d9b..1314cd50c3 100644 --- a/docs/command/atlas-privateEndpoints-regionalModes.txt +++ b/docs/command/atlas-privateEndpoints-regionalModes.txt @@ -14,6 +14,13 @@ atlas privateEndpoints regionalModes Manage regionalized private endpoint setting for your Atlas project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-privateEndpoints.txt b/docs/command/atlas-privateEndpoints.txt index 8a05ab2145..86ac946ac6 100644 --- a/docs/command/atlas-privateEndpoints.txt +++ b/docs/command/atlas-privateEndpoints.txt @@ -14,6 +14,13 @@ atlas privateEndpoints Manage Atlas private endpoints. +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. + + + + + Options ------- diff --git a/docs/command/atlas-processes-describe.txt b/docs/command/atlas-processes-describe.txt index d96733b374..064264d664 100644 --- a/docs/command/atlas-processes-describe.txt +++ b/docs/command/atlas-processes-describe.txt @@ -14,6 +14,13 @@ atlas processes describe Return the details for the specified MongoDB process for your project. +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/docs/command/atlas-processes-list.txt b/docs/command/atlas-processes-list.txt index 6f575dfbeb..c488e2fcd6 100644 --- a/docs/command/atlas-processes-list.txt +++ b/docs/command/atlas-processes-list.txt @@ -14,6 +14,11 @@ atlas processes list Return all MongoDB processes for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-processes.txt b/docs/command/atlas-processes.txt index 5fd7e81a35..866cb046f2 100644 --- a/docs/command/atlas-processes.txt +++ b/docs/command/atlas-processes.txt @@ -14,6 +14,13 @@ atlas processes Manage MongoDB processes for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-projects-apiKeys-assign.txt b/docs/command/atlas-projects-apiKeys-assign.txt index e08d747ceb..c4fff0074a 100644 --- a/docs/command/atlas-projects-apiKeys-assign.txt +++ b/docs/command/atlas-projects-apiKeys-assign.txt @@ -14,6 +14,11 @@ atlas projects apiKeys assign Assign the specified organization API key to your project and modify the API key's roles for the project. +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. + + + When you modify the roles for an organization API key with this command, the values you specify overwrite the existing roles assigned to the API key. To view possible values for the ID argument, run atlas organizations apiKeys list. diff --git a/docs/command/atlas-projects-apiKeys-create.txt b/docs/command/atlas-projects-apiKeys-create.txt index 78b06bbe97..91312ddc8a 100644 --- a/docs/command/atlas-projects-apiKeys-create.txt +++ b/docs/command/atlas-projects-apiKeys-create.txt @@ -14,6 +14,11 @@ atlas projects apiKeys create Create an organization API key and assign it to your project. +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. + + + MongoDB returns the private API key only once. After you run this command, immediately copy, save, and secure both the public and private API keys. If you don't provide an organization level role, the API Key defaults to organization member of the project parent organization. diff --git a/docs/command/atlas-projects-apiKeys-delete.txt b/docs/command/atlas-projects-apiKeys-delete.txt index c2b2fbc72c..7501f8b555 100644 --- a/docs/command/atlas-projects-apiKeys-delete.txt +++ b/docs/command/atlas-projects-apiKeys-delete.txt @@ -14,6 +14,11 @@ atlas projects apiKeys delete Remove the specified organization API key from your project. +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. + + + The API key still exists at the organization level. To reassign the organization API key to a project, run the atlas projects apiKeys assign command. To view possible values for the ID argument, run atlas organizations apiKeys list. diff --git a/docs/command/atlas-projects-apiKeys-list.txt b/docs/command/atlas-projects-apiKeys-list.txt index 4f26094679..41e8846d06 100644 --- a/docs/command/atlas-projects-apiKeys-list.txt +++ b/docs/command/atlas-projects-apiKeys-list.txt @@ -14,6 +14,11 @@ atlas projects apiKeys list Return all organization API keys assigned to your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project User Admin role. Syntax diff --git a/docs/command/atlas-projects-apiKeys.txt b/docs/command/atlas-projects-apiKeys.txt index aa4c4c61da..ba84de54e3 100644 --- a/docs/command/atlas-projects-apiKeys.txt +++ b/docs/command/atlas-projects-apiKeys.txt @@ -14,6 +14,13 @@ atlas projects apiKeys Manage API Keys for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-projects-create.txt b/docs/command/atlas-projects-create.txt index 2fa91868b6..f7dffbe5aa 100644 --- a/docs/command/atlas-projects-create.txt +++ b/docs/command/atlas-projects-create.txt @@ -14,6 +14,11 @@ atlas projects create Create a project in your organization. +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. + + + Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. diff --git a/docs/command/atlas-projects-delete.txt b/docs/command/atlas-projects-delete.txt index 840a40a2fa..1d2aaad0e1 100644 --- a/docs/command/atlas-projects-delete.txt +++ b/docs/command/atlas-projects-delete.txt @@ -14,6 +14,11 @@ atlas projects delete Remove the specified project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-projects-describe.txt b/docs/command/atlas-projects-describe.txt index 2d32ee6d1b..02dbf663d3 100644 --- a/docs/command/atlas-projects-describe.txt +++ b/docs/command/atlas-projects-describe.txt @@ -14,6 +14,11 @@ atlas projects describe Return the details for the specified project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-projects-list.txt b/docs/command/atlas-projects-list.txt index d34deeb096..1993d5de06 100644 --- a/docs/command/atlas-projects-list.txt +++ b/docs/command/atlas-projects-list.txt @@ -14,6 +14,11 @@ atlas projects list Return all projects. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. Syntax diff --git a/docs/command/atlas-projects-settings-describe.txt b/docs/command/atlas-projects-settings-describe.txt index a69830c3d1..01b89daaec 100644 --- a/docs/command/atlas-projects-settings-describe.txt +++ b/docs/command/atlas-projects-settings-describe.txt @@ -14,6 +14,13 @@ atlas projects settings describe Retrieve details for settings to the specified project. +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/docs/command/atlas-projects-settings-update.txt b/docs/command/atlas-projects-settings-update.txt index 3a8fe62e87..b2351b4304 100644 --- a/docs/command/atlas-projects-settings-update.txt +++ b/docs/command/atlas-projects-settings-update.txt @@ -14,6 +14,13 @@ atlas projects settings update Updates settings for a project. +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/docs/command/atlas-projects-settings.txt b/docs/command/atlas-projects-settings.txt index 8671663757..6ba1110600 100644 --- a/docs/command/atlas-projects-settings.txt +++ b/docs/command/atlas-projects-settings.txt @@ -14,6 +14,11 @@ atlas projects settings Settings operations. +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. + + + Manage your project settings. Options diff --git a/docs/command/atlas-projects-teams-add.txt b/docs/command/atlas-projects-teams-add.txt index f8670378f0..7194a8c4e8 100644 --- a/docs/command/atlas-projects-teams-add.txt +++ b/docs/command/atlas-projects-teams-add.txt @@ -14,6 +14,11 @@ atlas projects teams add Add the specified team to your project. +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. + + + All members of the team share the same project access. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-projects-teams-delete.txt b/docs/command/atlas-projects-teams-delete.txt index 1f5819a10d..1f10432b61 100644 --- a/docs/command/atlas-projects-teams-delete.txt +++ b/docs/command/atlas-projects-teams-delete.txt @@ -14,6 +14,11 @@ atlas projects teams delete Remove the specified team from your project. +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. + + + After you remove a team from your project, the team still exists in the organization in which it was created. To use this command, you must authenticate with a user account or an API key with the Project User Admin role. diff --git a/docs/command/atlas-projects-teams-list.txt b/docs/command/atlas-projects-teams-list.txt index 12e530a794..8bd4385f22 100644 --- a/docs/command/atlas-projects-teams-list.txt +++ b/docs/command/atlas-projects-teams-list.txt @@ -14,6 +14,11 @@ atlas projects teams list Return all teams for a project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-projects-teams-update.txt b/docs/command/atlas-projects-teams-update.txt index 02527e0e2e..5090822fbc 100644 --- a/docs/command/atlas-projects-teams-update.txt +++ b/docs/command/atlas-projects-teams-update.txt @@ -14,6 +14,11 @@ atlas projects teams update Modify the roles for the specified team for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project User Admin role. Syntax diff --git a/docs/command/atlas-projects-teams.txt b/docs/command/atlas-projects-teams.txt index b215be2184..7b11e7f1c9 100644 --- a/docs/command/atlas-projects-teams.txt +++ b/docs/command/atlas-projects-teams.txt @@ -14,6 +14,13 @@ atlas projects teams Manage your Atlas teams. +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. + + + + + Options ------- diff --git a/docs/command/atlas-projects-update.txt b/docs/command/atlas-projects-update.txt index 3c037c1528..8c2d7cc102 100644 --- a/docs/command/atlas-projects-update.txt +++ b/docs/command/atlas-projects-update.txt @@ -14,6 +14,11 @@ atlas projects update Update a project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-projects-users-delete.txt b/docs/command/atlas-projects-users-delete.txt index 870543b4f6..873b0416eb 100644 --- a/docs/command/atlas-projects-users-delete.txt +++ b/docs/command/atlas-projects-users-delete.txt @@ -14,6 +14,11 @@ atlas projects users delete Remove the specified user from your project. +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. + + + After you remove a user from your project, the user still exists in the organization in which it was created. To use this command, you must authenticate with a user account or an API key with the Project User Admin role. diff --git a/docs/command/atlas-projects-users-list.txt b/docs/command/atlas-projects-users-list.txt index fda0542dcb..fadf573f78 100644 --- a/docs/command/atlas-projects-users-list.txt +++ b/docs/command/atlas-projects-users-list.txt @@ -14,6 +14,11 @@ atlas projects users list Return all users for a project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-projects-users.txt b/docs/command/atlas-projects-users.txt index 0292d11497..072ab816c9 100644 --- a/docs/command/atlas-projects-users.txt +++ b/docs/command/atlas-projects-users.txt @@ -14,6 +14,13 @@ atlas projects users Manage users for a project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-projects.txt b/docs/command/atlas-projects.txt index b7e5825090..c7ea4e8304 100644 --- a/docs/command/atlas-projects.txt +++ b/docs/command/atlas-projects.txt @@ -14,6 +14,11 @@ atlas projects Manage your Atlas projects. +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. + + + Create, list and manage your MongoDB projects. Options diff --git a/docs/command/atlas-security-customerCerts-create.txt b/docs/command/atlas-security-customerCerts-create.txt index f22030f134..5d573b29f4 100644 --- a/docs/command/atlas-security-customerCerts-create.txt +++ b/docs/command/atlas-security-customerCerts-create.txt @@ -14,6 +14,11 @@ atlas security customerCerts create Saves a customer-managed X.509 configuration for your project. +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. + + + Saving a customer-managed X.509 configuration triggers a rolling restart. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-security-customerCerts-describe.txt b/docs/command/atlas-security-customerCerts-describe.txt index c94b4cad31..73c488a5a0 100644 --- a/docs/command/atlas-security-customerCerts-describe.txt +++ b/docs/command/atlas-security-customerCerts-describe.txt @@ -14,6 +14,11 @@ atlas security customerCerts describe Return the details for the current customer-managed X.509 configuration for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-security-customerCerts-disable.txt b/docs/command/atlas-security-customerCerts-disable.txt index c45f4712e1..53f2727ac5 100644 --- a/docs/command/atlas-security-customerCerts-disable.txt +++ b/docs/command/atlas-security-customerCerts-disable.txt @@ -14,6 +14,11 @@ atlas security customerCerts disable Clear customer-managed X.509 settings on a project, including the uploaded Certificate Authority, and disable self-managed X.509. +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. + + + Disabling customer-managed X.509 triggers a rolling restart. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-security-customerCerts.txt b/docs/command/atlas-security-customerCerts.txt index 9b8a81fb98..f99bba7e9c 100644 --- a/docs/command/atlas-security-customerCerts.txt +++ b/docs/command/atlas-security-customerCerts.txt @@ -14,6 +14,13 @@ atlas security customerCerts Manage customer x509 certificates for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-security-ldap-delete.txt b/docs/command/atlas-security-ldap-delete.txt index 1a26083803..4fb081bec3 100644 --- a/docs/command/atlas-security-ldap-delete.txt +++ b/docs/command/atlas-security-ldap-delete.txt @@ -14,6 +14,11 @@ atlas security ldap delete Remove the current LDAP configuration captured in the userToDNMapping document from your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-security-ldap-get.txt b/docs/command/atlas-security-ldap-get.txt index 359a0931fc..faef6899dd 100644 --- a/docs/command/atlas-security-ldap-get.txt +++ b/docs/command/atlas-security-ldap-get.txt @@ -14,6 +14,11 @@ atlas security ldap get Return the current LDAP configuration details for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-security-ldap-save.txt b/docs/command/atlas-security-ldap-save.txt index 8bae744bc4..ebc5e6ac4e 100644 --- a/docs/command/atlas-security-ldap-save.txt +++ b/docs/command/atlas-security-ldap-save.txt @@ -14,6 +14,11 @@ atlas security ldap save Save an LDAP configuration for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-security-ldap-verify-status-watch.txt b/docs/command/atlas-security-ldap-verify-status-watch.txt index 8a13c69d21..3e5781742c 100644 --- a/docs/command/atlas-security-ldap-verify-status-watch.txt +++ b/docs/command/atlas-security-ldap-verify-status-watch.txt @@ -14,6 +14,11 @@ atlas security ldap verify status watch Watch for an LDAP configuration request to complete. +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. + + + This command checks the LDAP configuration's status periodically until it reaches a SUCCESS or FAILED status. Once the LDAP configuration reaches the expected status, the command prints "LDAP Configuration request completed." If you run the command in the terminal, it blocks the terminal session until the resource status succeeds or fails. diff --git a/docs/command/atlas-security-ldap-verify-status.txt b/docs/command/atlas-security-ldap-verify-status.txt index 3458531de3..b419753a15 100644 --- a/docs/command/atlas-security-ldap-verify-status.txt +++ b/docs/command/atlas-security-ldap-verify-status.txt @@ -14,6 +14,11 @@ atlas security ldap verify status Get the status of an LDAP configuration request. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-security-ldap-verify.txt b/docs/command/atlas-security-ldap-verify.txt index 1a76e01654..2ec1b45b5c 100644 --- a/docs/command/atlas-security-ldap-verify.txt +++ b/docs/command/atlas-security-ldap-verify.txt @@ -14,6 +14,11 @@ atlas security ldap verify Request verification of an LDAP configuration for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-security-ldap.txt b/docs/command/atlas-security-ldap.txt index 20627d1405..ff9c4b1cce 100644 --- a/docs/command/atlas-security-ldap.txt +++ b/docs/command/atlas-security-ldap.txt @@ -14,6 +14,13 @@ atlas security ldap LDAP operations. +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. + + + + + Options ------- diff --git a/docs/command/atlas-security.txt b/docs/command/atlas-security.txt index 3457b5871d..da1144d779 100644 --- a/docs/command/atlas-security.txt +++ b/docs/command/atlas-security.txt @@ -14,6 +14,13 @@ atlas security Manage security configuration for your project. +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. + + + + + Options ------- diff --git a/docs/command/atlas-setup.txt b/docs/command/atlas-setup.txt index f22446e870..4b19fc3a39 100644 --- a/docs/command/atlas-setup.txt +++ b/docs/command/atlas-setup.txt @@ -14,6 +14,11 @@ atlas setup Register, authenticate, create, and access an Atlas cluster. +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. + + + This command takes you through registration, login, default profile creation, creating your first free tier cluster and connecting to it using MongoDB Shell. Syntax diff --git a/docs/command/atlas-streams-connections-create.txt b/docs/command/atlas-streams-connections-create.txt index 41218f319d..853805c5be 100644 --- a/docs/command/atlas-streams-connections-create.txt +++ b/docs/command/atlas-streams-connections-create.txt @@ -14,6 +14,11 @@ atlas streams connections create Creates a connection for an Atlas Stream Processing instance. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-streams-connections-delete.txt b/docs/command/atlas-streams-connections-delete.txt index 28a82a8881..7ad329f386 100644 --- a/docs/command/atlas-streams-connections-delete.txt +++ b/docs/command/atlas-streams-connections-delete.txt @@ -14,6 +14,11 @@ atlas streams connections delete Remove the specified Atlas Stream Processing connection from your project. +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. + + + The command prompts you to confirm the operation when you run the command without the --force option. Before deleting an Atlas Streams Processing connection, you must first stop all processes associated with it. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-streams-connections-describe.txt b/docs/command/atlas-streams-connections-describe.txt index 9c0081ac67..3aa0a5b750 100644 --- a/docs/command/atlas-streams-connections-describe.txt +++ b/docs/command/atlas-streams-connections-describe.txt @@ -14,6 +14,11 @@ atlas streams connections describe Return the details for the specified Atlas Stream Processing connection. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-streams-connections-list.txt b/docs/command/atlas-streams-connections-list.txt index 3acd0d2a5d..41ee6fc3ae 100644 --- a/docs/command/atlas-streams-connections-list.txt +++ b/docs/command/atlas-streams-connections-list.txt @@ -14,6 +14,11 @@ atlas streams connections list Returns all Atlas Stream Processing connections from your Atlas Stream Processing instance. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-streams-connections-update.txt b/docs/command/atlas-streams-connections-update.txt index 12c4c249b7..ecd625b87c 100644 --- a/docs/command/atlas-streams-connections-update.txt +++ b/docs/command/atlas-streams-connections-update.txt @@ -14,6 +14,11 @@ atlas streams connections update Modify the details of the specified connection within your Atlas Stream Processing instance. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-streams-connections.txt b/docs/command/atlas-streams-connections.txt index 2c40745051..cd3cafa2c5 100644 --- a/docs/command/atlas-streams-connections.txt +++ b/docs/command/atlas-streams-connections.txt @@ -14,6 +14,11 @@ atlas streams connections Manage Atlas Stream Processing connections. +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. + + + Create, list, update and delete your Atlas Stream Processing connections Options diff --git a/docs/command/atlas-streams-instances-create.txt b/docs/command/atlas-streams-instances-create.txt index 7b3f705da8..e1f3b620fb 100644 --- a/docs/command/atlas-streams-instances-create.txt +++ b/docs/command/atlas-streams-instances-create.txt @@ -14,6 +14,11 @@ atlas streams instances create Create an Atlas Stream Processing instance for your project +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. + + + To get started quickly, specify a name, a cloud provider, and a region to configure an Atlas Stream Processing instance.To use this command, you must authenticate with a user account or an API key with the Project Owner role. Syntax diff --git a/docs/command/atlas-streams-instances-delete.txt b/docs/command/atlas-streams-instances-delete.txt index f7e1a66ae8..940cf5bbfb 100644 --- a/docs/command/atlas-streams-instances-delete.txt +++ b/docs/command/atlas-streams-instances-delete.txt @@ -14,6 +14,11 @@ atlas streams instances delete Delete an Atlas Stream Processing instance. +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. + + + The command prompts you to confirm the operation when you run the command without the --force option. Before deleting an Atlas Streams Processing instance, you must first stop all processes associated with it. diff --git a/docs/command/atlas-streams-instances-describe.txt b/docs/command/atlas-streams-instances-describe.txt index e701019c47..1f4c29d4ad 100644 --- a/docs/command/atlas-streams-instances-describe.txt +++ b/docs/command/atlas-streams-instances-describe.txt @@ -14,6 +14,11 @@ atlas streams instances describe Describe an Atlas Stream Processing instance for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-streams-instances-download.txt b/docs/command/atlas-streams-instances-download.txt index 8cee843c81..9407e81fcf 100644 --- a/docs/command/atlas-streams-instances-download.txt +++ b/docs/command/atlas-streams-instances-download.txt @@ -14,6 +14,11 @@ atlas streams instances download Download a compressed file that contains the logs for the specified Atlas Stream Processing instance. +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. + + + This command downloads a file with a .gz extension. To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. Syntax diff --git a/docs/command/atlas-streams-instances-list.txt b/docs/command/atlas-streams-instances-list.txt index 43620f92c8..164d1dc330 100644 --- a/docs/command/atlas-streams-instances-list.txt +++ b/docs/command/atlas-streams-instances-list.txt @@ -14,6 +14,11 @@ atlas streams instances list List all the Atlas Stream Processing instances for your project. +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. + + + To use this command, you must authenticate with a user account or an API key with the Project Read Only role. Syntax diff --git a/docs/command/atlas-streams-instances-update.txt b/docs/command/atlas-streams-instances-update.txt index fb6875d5fa..edbbd29a28 100644 --- a/docs/command/atlas-streams-instances-update.txt +++ b/docs/command/atlas-streams-instances-update.txt @@ -14,6 +14,11 @@ atlas streams instances update Updates an Atlas Stream Processing instance for your project. +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. + + + Before updating an Atlas Streams Processing instance, you must first stop all processes associated with it. To use this command, you must authenticate with a user account or an API key with the Project Owner role. diff --git a/docs/command/atlas-streams-instances.txt b/docs/command/atlas-streams-instances.txt index 88cb43a8a5..1d6cd3a275 100644 --- a/docs/command/atlas-streams-instances.txt +++ b/docs/command/atlas-streams-instances.txt @@ -14,6 +14,11 @@ atlas streams instances Manage Atlas Stream Processing instances. +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. + + + Create, list, update and delete your Atlas Stream Processing instances. Options diff --git a/docs/command/atlas-streams-privateLinks-create.txt b/docs/command/atlas-streams-privateLinks-create.txt index ff0d3d6fe9..24fbd53efc 100644 --- a/docs/command/atlas-streams-privateLinks-create.txt +++ b/docs/command/atlas-streams-privateLinks-create.txt @@ -14,6 +14,11 @@ atlas streams privateLinks create Creates a PrivateLink endpoint that can be used as an Atlas Stream Processor connection. +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. + + + To use this command, you must authenticate with a user account or an API key with any of the following roles: Project Owner, Project Stream Processing Owner. Syntax diff --git a/docs/command/atlas-streams-privateLinks-delete.txt b/docs/command/atlas-streams-privateLinks-delete.txt index 9d7ca42f84..cec3782bf0 100644 --- a/docs/command/atlas-streams-privateLinks-delete.txt +++ b/docs/command/atlas-streams-privateLinks-delete.txt @@ -14,6 +14,11 @@ atlas streams privateLinks delete Deletes an Atlas Stream Processing PrivateLink endpoint. +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. + + + To use this command, you must authenticate with a user account or an API key with any of the following roles: Project Owner, Project Stream Processing Owner. Syntax diff --git a/docs/command/atlas-streams-privateLinks-describe.txt b/docs/command/atlas-streams-privateLinks-describe.txt index 202502f7ec..aa3027e9ad 100644 --- a/docs/command/atlas-streams-privateLinks-describe.txt +++ b/docs/command/atlas-streams-privateLinks-describe.txt @@ -14,6 +14,11 @@ atlas streams privateLinks describe Describes a PrivateLink endpoint that can be used as an Atlas Stream Processor connection. +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. + + + To use this command, you must authenticate with a user account or an API key with any of the following roles: Project Owner, Project Stream Processing Owner. Syntax diff --git a/docs/command/atlas-streams-privateLinks-list.txt b/docs/command/atlas-streams-privateLinks-list.txt index 064f1e9cf7..c3f132d634 100644 --- a/docs/command/atlas-streams-privateLinks-list.txt +++ b/docs/command/atlas-streams-privateLinks-list.txt @@ -14,6 +14,11 @@ atlas streams privateLinks list Lists the PrivateLink endpoints in the project that can be used as Atlas Stream Processor connections. +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. + + + To use this command, you must authenticate with a user account or an API key with any of the following roles: Project Owner, Project Stream Processing Owner. Syntax diff --git a/docs/command/atlas-streams-privateLinks.txt b/docs/command/atlas-streams-privateLinks.txt index 47740b5d20..1665d31265 100644 --- a/docs/command/atlas-streams-privateLinks.txt +++ b/docs/command/atlas-streams-privateLinks.txt @@ -14,6 +14,11 @@ atlas streams privateLinks Manage Atlas Stream Processing PrivateLink endpoints. +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. + + + Create your Atlas Stream Processing PrivateLink endpoints Options diff --git a/docs/command/atlas-streams.txt b/docs/command/atlas-streams.txt index d0a648bac8..5a458be2d6 100644 --- a/docs/command/atlas-streams.txt +++ b/docs/command/atlas-streams.txt @@ -14,6 +14,11 @@ atlas streams Manage your Atlas Stream Processing deployments. +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. + + + The streams command provides access to your Atlas Stream Processing configurations. You can create, edit, and delete streams, as well as change the connection registry. Options diff --git a/docs/command/atlas-teams-create.txt b/docs/command/atlas-teams-create.txt index 9bb807539e..83bfc9fccf 100644 --- a/docs/command/atlas-teams-create.txt +++ b/docs/command/atlas-teams-create.txt @@ -14,6 +14,11 @@ atlas teams create Create a team for your organization. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization Owner role. Syntax diff --git a/docs/command/atlas-teams-delete.txt b/docs/command/atlas-teams-delete.txt index 3be0a283e1..d75e4b6c4b 100644 --- a/docs/command/atlas-teams-delete.txt +++ b/docs/command/atlas-teams-delete.txt @@ -14,6 +14,11 @@ atlas teams delete Remove the specified team from your organization. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. Syntax diff --git a/docs/command/atlas-teams-describe.txt b/docs/command/atlas-teams-describe.txt index e13b21c7d0..ca91b21dca 100644 --- a/docs/command/atlas-teams-describe.txt +++ b/docs/command/atlas-teams-describe.txt @@ -14,6 +14,11 @@ atlas teams describe Return the details for the specified team for your organization. +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. + + + You can return the details for a team using the team's ID or the team's name. You must specify either the id option or the name option. To use this command, you must authenticate with a user account or an API key with the Organization Member role. diff --git a/docs/command/atlas-teams-list.txt b/docs/command/atlas-teams-list.txt index f454ff6762..dd50da867d 100644 --- a/docs/command/atlas-teams-list.txt +++ b/docs/command/atlas-teams-list.txt @@ -14,6 +14,11 @@ atlas teams list Return all teams for your organization. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/docs/command/atlas-teams-rename.txt b/docs/command/atlas-teams-rename.txt index 867a75b2f8..4579c28dd5 100644 --- a/docs/command/atlas-teams-rename.txt +++ b/docs/command/atlas-teams-rename.txt @@ -14,6 +14,11 @@ atlas teams rename Rename a team in your organization. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization Owner role. Syntax diff --git a/docs/command/atlas-teams-users-add.txt b/docs/command/atlas-teams-users-add.txt index eeb6319874..355c84ab3d 100644 --- a/docs/command/atlas-teams-users-add.txt +++ b/docs/command/atlas-teams-users-add.txt @@ -14,6 +14,11 @@ atlas teams users add Add the specified MongoDB user to a team for your organization. +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. + + + You can add users that are part of the organization or users that have been sent an invitation to join the organization. To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. diff --git a/docs/command/atlas-teams-users-delete.txt b/docs/command/atlas-teams-users-delete.txt index 4cd64e07bd..bd9495fb65 100644 --- a/docs/command/atlas-teams-users-delete.txt +++ b/docs/command/atlas-teams-users-delete.txt @@ -14,6 +14,11 @@ atlas teams users delete Remove the specified user from a team for your organization. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. Syntax diff --git a/docs/command/atlas-teams-users-list.txt b/docs/command/atlas-teams-users-list.txt index ae494e0213..6c24a4fd05 100644 --- a/docs/command/atlas-teams-users-list.txt +++ b/docs/command/atlas-teams-users-list.txt @@ -14,6 +14,11 @@ atlas teams users list Return all users for a team. +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. + + + To use this command, you must authenticate with a user account or an API key with the Organization Member role. Syntax diff --git a/docs/command/atlas-teams-users.txt b/docs/command/atlas-teams-users.txt index d8724b0790..1da6bd8d9b 100644 --- a/docs/command/atlas-teams-users.txt +++ b/docs/command/atlas-teams-users.txt @@ -14,6 +14,11 @@ atlas teams users Manage your Atlas users. +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. + + + Create, list and manage your users. Options diff --git a/docs/command/atlas-teams.txt b/docs/command/atlas-teams.txt index a32ada2f2b..fb5675a7f7 100644 --- a/docs/command/atlas-teams.txt +++ b/docs/command/atlas-teams.txt @@ -14,6 +14,11 @@ atlas teams Manage your Atlas teams. +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. + + + Create, list and manage your Atlas teams. Options diff --git a/docs/command/atlas-users-describe.txt b/docs/command/atlas-users-describe.txt index 4ec47d18a5..039d628e30 100644 --- a/docs/command/atlas-users-describe.txt +++ b/docs/command/atlas-users-describe.txt @@ -14,6 +14,11 @@ atlas users describe Return the details for the specified Atlas user. +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. + + + You can specify either the unique 24-digit ID that identifies the Atlas user or the username for the Atlas user. User accounts and API keys with any role can run this command. diff --git a/docs/command/atlas-users-invite.txt b/docs/command/atlas-users-invite.txt index 7b5ebd3250..f2b351604c 100644 --- a/docs/command/atlas-users-invite.txt +++ b/docs/command/atlas-users-invite.txt @@ -14,6 +14,11 @@ atlas users invite Create an Atlas user for your MongoDB Atlas application and invite the Atlas user to your organizations and projects. +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. + + + An Atlas user account grants access only to the the MongoDB Atlas application. To grant database access, create a database user with atlas dbusers create. Syntax diff --git a/docs/command/atlas-users.txt b/docs/command/atlas-users.txt index 7507d266ab..08d0588408 100644 --- a/docs/command/atlas-users.txt +++ b/docs/command/atlas-users.txt @@ -14,6 +14,11 @@ atlas users Manage your Atlas users. +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. + + + Create and manage your Atlas users. Options diff --git a/docs/command/atlas.txt b/docs/command/atlas.txt index 494fe95004..d1ebf9fdcc 100644 --- a/docs/command/atlas.txt +++ b/docs/command/atlas.txt @@ -14,6 +14,11 @@ atlas CLI tool to manage MongoDB Atlas. +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. + + + The Atlas CLI is a command line interface built specifically for MongoDB Atlas. You can manage your Atlas database deployments and Atlas Search from the terminal with short, intuitive commands. Use the --help flag with any command for more info on that command. diff --git a/tools/cmd/docs/transformations.go b/tools/cmd/docs/transformations.go index 01a6f29026..b3edc5c905 100644 --- a/tools/cmd/docs/transformations.go +++ b/tools/cmd/docs/transformations.go @@ -41,6 +41,7 @@ var additionalLongTexts = map[string]string{ func addAdditionalLongText(cmd *cobra.Command) { commandPath := cmd.CommandPath() + cmd.Long = cli.ExperimentalText + "\n\n" + cmd.Long if additionalLongText, found := additionalLongTexts[commandPath]; found && additionalLongText != "" { cmd.Long += "\n\n" cmd.Long += additionalLongText @@ -59,7 +60,7 @@ func markExperimentalToAPICommands(cmd *cobra.Command) { if cmd.CommandPath() == "atlas api" { return // Skip the root command } - cmd.Short = cli.ExperimentalText + cmd.Short + cmd.Short = "`Public Preview: please provide feedback `_: " + cmd.Short + cmd.Short } func updateAPICommandDescription(cmd *cobra.Command) { From 848cbf4e8fb0bb0f9bf5149ce21399dcdf6d9043 Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Fri, 23 May 2025 11:30:44 +0200 Subject: [PATCH 3/4] Update api.go --- docs/command/atlas-api.txt | 2 +- docs/command/atlas.txt | 2 +- internal/cli/api/api.go | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/command/atlas-api.txt b/docs/command/atlas-api.txt index 2dc9699342..c42e308dfa 100644 --- a/docs/command/atlas-api.txt +++ b/docs/command/atlas-api.txt @@ -12,7 +12,7 @@ atlas api :depth: 1 :class: singlecol -Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: '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 '. 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. diff --git a/docs/command/atlas.txt b/docs/command/atlas.txt index d1ebf9fdcc..e06426ead4 100644 --- a/docs/command/atlas.txt +++ b/docs/command/atlas.txt @@ -58,7 +58,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` - 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-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. diff --git a/internal/cli/api/api.go b/internal/cli/api/api.go index 6cc3bdfd83..871b966091 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: `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. For more information on From adedaf604885de95e70e83ea8862afbe97dd56cd Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Fri, 23 May 2025 11:32:42 +0200 Subject: [PATCH 4/4] fix --- ...ssTracking-listAccessLogsByClusterName.txt | 2 +- ...ccessTracking-listAccessLogsByHostname.txt | 2 +- docs/command/atlas-api-accessTracking.txt | 6 +- ...onfigurations-createAlertConfiguration.txt | 2 +- ...onfigurations-deleteAlertConfiguration.txt | 2 +- ...rtConfigurations-getAlertConfiguration.txt | 2 +- ...stAlertConfigurationMatchersFieldNames.txt | 2 +- ...Configurations-listAlertConfigurations.txt | 2 +- ...tions-listAlertConfigurationsByAlertId.txt | 2 +- ...onfigurations-toggleAlertConfiguration.txt | 2 +- ...onfigurations-updateAlertConfiguration.txt | 2 +- .../command/atlas-api-alertConfigurations.txt | 18 ++-- .../atlas-api-alerts-acknowledgeAlert.txt | 2 +- docs/command/atlas-api-alerts-getAlert.txt | 2 +- docs/command/atlas-api-alerts-listAlerts.txt | 2 +- ...lerts-listAlertsByAlertConfigurationId.txt | 2 +- docs/command/atlas-api-alerts.txt | 10 +- ...tlasSearch-createAtlasSearchDeployment.txt | 2 +- ...api-atlasSearch-createAtlasSearchIndex.txt | 2 +- ...earch-createAtlasSearchIndexDeprecated.txt | 2 +- ...tlasSearch-deleteAtlasSearchDeployment.txt | 2 +- ...api-atlasSearch-deleteAtlasSearchIndex.txt | 2 +- ...lasSearch-deleteAtlasSearchIndexByName.txt | 2 +- ...earch-deleteAtlasSearchIndexDeprecated.txt | 2 +- ...i-atlasSearch-getAtlasSearchDeployment.txt | 2 +- ...as-api-atlasSearch-getAtlasSearchIndex.txt | 2 +- ...-atlasSearch-getAtlasSearchIndexByName.txt | 2 +- ...asSearch-getAtlasSearchIndexDeprecated.txt | 2 +- ...api-atlasSearch-listAtlasSearchIndexes.txt | 2 +- ...asSearch-listAtlasSearchIndexesCluster.txt | 2 +- ...earch-listAtlasSearchIndexesDeprecated.txt | 2 +- ...tlasSearch-updateAtlasSearchDeployment.txt | 2 +- ...api-atlasSearch-updateAtlasSearchIndex.txt | 2 +- ...lasSearch-updateAtlasSearchIndexByName.txt | 2 +- ...earch-updateAtlasSearchIndexDeprecated.txt | 2 +- docs/command/atlas-api-atlasSearch.txt | 38 +++---- ...-api-auditing-getAuditingConfiguration.txt | 2 +- ...i-auditing-updateAuditingConfiguration.txt | 2 +- docs/command/atlas-api-auditing.txt | 6 +- ...las-api-awsClustersDns-getAwsCustomDns.txt | 2 +- ...-api-awsClustersDns-toggleAwsCustomDns.txt | 2 +- docs/command/atlas-api-awsClustersDns.txt | 6 +- ...pi-cloudBackups-cancelBackupRestoreJob.txt | 2 +- ...api-cloudBackups-createBackupExportJob.txt | 2 +- ...pi-cloudBackups-createBackupRestoreJob.txt | 2 +- ...as-api-cloudBackups-createExportBucket.txt | 2 +- ...ckups-createServerlessBackupRestoreJob.txt | 2 +- ...-cloudBackups-deleteAllBackupSchedules.txt | 2 +- ...as-api-cloudBackups-deleteExportBucket.txt | 2 +- ...pi-cloudBackups-deleteReplicaSetBackup.txt | 2 +- ...loudBackups-deleteShardedClusterBackup.txt | 2 +- ...dBackups-disableDataProtectionSettings.txt | 2 +- ...as-api-cloudBackups-getBackupExportJob.txt | 2 +- ...s-api-cloudBackups-getBackupRestoreJob.txt | 2 +- ...las-api-cloudBackups-getBackupSchedule.txt | 2 +- ...cloudBackups-getDataProtectionSettings.txt | 2 +- ...atlas-api-cloudBackups-getExportBucket.txt | 2 +- ...s-api-cloudBackups-getReplicaSetBackup.txt | 2 +- ...s-api-cloudBackups-getServerlessBackup.txt | 2 +- ...dBackups-getServerlessBackupRestoreJob.txt | 2 +- ...i-cloudBackups-getShardedClusterBackup.txt | 2 +- ...-api-cloudBackups-listBackupExportJobs.txt | 2 +- ...api-cloudBackups-listBackupRestoreJobs.txt | 2 +- ...las-api-cloudBackups-listExportBuckets.txt | 2 +- ...api-cloudBackups-listReplicaSetBackups.txt | 2 +- ...ackups-listServerlessBackupRestoreJobs.txt | 2 +- ...api-cloudBackups-listServerlessBackups.txt | 2 +- ...cloudBackups-listShardedClusterBackups.txt | 2 +- .../atlas-api-cloudBackups-takeSnapshot.txt | 2 +- ...-api-cloudBackups-updateBackupSchedule.txt | 2 +- ...udBackups-updateDataProtectionSettings.txt | 2 +- ...i-cloudBackups-updateSnapshotRetention.txt | 2 +- docs/command/atlas-api-cloudBackups.txt | 62 +++++------ ...-cloudMigrationService-createLinkToken.txt | 2 +- ...udMigrationService-createPushMigration.txt | 2 +- ...cloudMigrationService-cutoverMigration.txt | 2 +- ...-cloudMigrationService-deleteLinkToken.txt | 2 +- ...cloudMigrationService-getPushMigration.txt | 2 +- ...udMigrationService-getValidationStatus.txt | 2 +- ...oudMigrationService-listSourceProjects.txt | 2 +- ...loudMigrationService-validateMigration.txt | 2 +- .../atlas-api-cloudMigrationService.txt | 18 ++-- ...ccess-authorizeCloudProviderAccessRole.txt | 2 +- ...erAccess-createCloudProviderAccessRole.txt | 2 +- ...ess-deauthorizeCloudProviderAccessRole.txt | 2 +- ...viderAccess-getCloudProviderAccessRole.txt | 2 +- ...derAccess-listCloudProviderAccessRoles.txt | 2 +- .../command/atlas-api-cloudProviderAccess.txt | 12 +-- ...erOutageSimulation-endOutageSimulation.txt | 2 +- ...erOutageSimulation-getOutageSimulation.txt | 2 +- ...OutageSimulation-startOutageSimulation.txt | 2 +- .../atlas-api-clusterOutageSimulation.txt | 8 +- ...-api-clusters-autoScalingConfiguration.txt | 2 +- .../atlas-api-clusters-createCluster.txt | 2 +- .../atlas-api-clusters-deleteCluster.txt | 2 +- .../command/atlas-api-clusters-getCluster.txt | 2 +- ...usters-getClusterAdvancedConfiguration.txt | 2 +- .../atlas-api-clusters-getClusterStatus.txt | 2 +- ...pi-clusters-getSampleDatasetLoadStatus.txt | 2 +- ...pi-clusters-grantMongoDbEmployeeAccess.txt | 2 +- ...-api-clusters-listCloudProviderRegions.txt | 2 +- .../atlas-api-clusters-listClusters.txt | 2 +- ...pi-clusters-listClustersForAllProjects.txt | 2 +- .../atlas-api-clusters-loadSampleDataset.txt | 2 +- ...lusters-pinFeatureCompatibilityVersion.txt | 2 +- ...i-clusters-revokeMongoDbEmployeeAccess.txt | 2 +- .../atlas-api-clusters-testFailover.txt | 2 +- ...sters-unpinFeatureCompatibilityVersion.txt | 2 +- .../atlas-api-clusters-updateCluster.txt | 2 +- ...ers-updateClusterAdvancedConfiguration.txt | 2 +- ...tlas-api-clusters-upgradeSharedCluster.txt | 2 +- docs/command/atlas-api-clusters.txt | 40 +++---- ...atsLatencyNamespaceClusterMeasurements.txt | 2 +- ...lStatsLatencyNamespaceHostMeasurements.txt | 2 +- ...cs-getCollStatsLatencyNamespaceMetrics.txt | 2 +- ...etCollStatsLatencyNamespacesForCluster.txt | 2 +- ...s-getCollStatsLatencyNamespacesForHost.txt | 2 +- ...ectionLevelMetrics-getPinnedNamespaces.txt | 2 +- ...lectionLevelMetrics-pinNamespacesPatch.txt | 2 +- ...ollectionLevelMetrics-pinNamespacesPut.txt | 2 +- ...collectionLevelMetrics-unpinNamespaces.txt | 2 +- .../atlas-api-collectionLevelMetrics.txt | 20 ++-- ...DatabaseRoles-createCustomDatabaseRole.txt | 2 +- ...DatabaseRoles-deleteCustomDatabaseRole.txt | 2 +- ...tomDatabaseRoles-getCustomDatabaseRole.txt | 2 +- ...mDatabaseRoles-listCustomDatabaseRoles.txt | 2 +- ...DatabaseRoles-updateCustomDatabaseRole.txt | 2 +- .../command/atlas-api-customDatabaseRoles.txt | 12 +-- ...on-createDataFederationPrivateEndpoint.txt | 2 +- ...dataFederation-createFederatedDatabase.txt | 2 +- ...tion-createOneDataFederationQueryLimit.txt | 2 +- ...on-deleteDataFederationPrivateEndpoint.txt | 2 +- ...dataFederation-deleteFederatedDatabase.txt | 2 +- ...eteOneDataFederationInstanceQueryLimit.txt | 2 +- ...ion-downloadFederatedDatabaseQueryLogs.txt | 2 +- ...ation-getDataFederationPrivateEndpoint.txt | 2 +- ...pi-dataFederation-getFederatedDatabase.txt | 2 +- ...ion-listDataFederationPrivateEndpoints.txt | 2 +- ...-dataFederation-listFederatedDatabases.txt | 2 +- ...tion-returnFederatedDatabaseQueryLimit.txt | 2 +- ...ion-returnFederatedDatabaseQueryLimits.txt | 2 +- ...dataFederation-updateFederatedDatabase.txt | 2 +- docs/command/atlas-api-dataFederation.txt | 30 +++--- ...s-api-dataLakePipelines-createPipeline.txt | 2 +- ...s-api-dataLakePipelines-deletePipeline.txt | 2 +- ...LakePipelines-deletePipelineRunDataset.txt | 2 +- ...tlas-api-dataLakePipelines-getPipeline.txt | 2 +- ...s-api-dataLakePipelines-getPipelineRun.txt | 2 +- ...api-dataLakePipelines-listPipelineRuns.txt | 2 +- ...ataLakePipelines-listPipelineSchedules.txt | 2 +- ...ataLakePipelines-listPipelineSnapshots.txt | 2 +- ...as-api-dataLakePipelines-listPipelines.txt | 2 +- ...as-api-dataLakePipelines-pausePipeline.txt | 2 +- ...s-api-dataLakePipelines-resumePipeline.txt | 2 +- ...LakePipelines-triggerSnapshotIngestion.txt | 2 +- ...s-api-dataLakePipelines-updatePipeline.txt | 2 +- docs/command/atlas-api-dataLakePipelines.txt | 28 ++--- ...s-api-databaseUsers-createDatabaseUser.txt | 2 +- ...s-api-databaseUsers-deleteDatabaseUser.txt | 2 +- ...tlas-api-databaseUsers-getDatabaseUser.txt | 2 +- ...as-api-databaseUsers-listDatabaseUsers.txt | 2 +- ...s-api-databaseUsers-updateDatabaseUser.txt | 2 +- docs/command/atlas-api-databaseUsers.txt | 12 +-- ...-createEncryptionAtRestPrivateEndpoint.txt | 2 +- ...tomerKeyManagement-getEncryptionAtRest.txt | 2 +- ...ent-getEncryptionAtRestPrivateEndpoint.txt | 2 +- ...AtRestPrivateEndpointsForCloudProvider.txt | 2 +- ...ncryptionAtRestPrivateEndpointDeletion.txt | 2 +- ...erKeyManagement-updateEncryptionAtRest.txt | 2 +- ...yptionAtRestUsingCustomerKeyManagement.txt | 14 +-- .../atlas-api-events-getOrganizationEvent.txt | 2 +- .../atlas-api-events-getProjectEvent.txt | 2 +- .../atlas-api-events-listEventTypes.txt | 2 +- ...tlas-api-events-listOrganizationEvents.txt | 2 +- .../atlas-api-events-listProjectEvents.txt | 2 +- docs/command/atlas-api-events.txt | 12 +-- ...dAuthentication-createIdentityProvider.txt | 2 +- ...eratedAuthentication-createRoleMapping.txt | 2 +- ...atedAuthentication-deleteFederationApp.txt | 2 +- ...dAuthentication-deleteIdentityProvider.txt | 2 +- ...eratedAuthentication-deleteRoleMapping.txt | 2 +- ...edAuthentication-getConnectedOrgConfig.txt | 2 +- ...edAuthentication-getFederationSettings.txt | 2 +- ...atedAuthentication-getIdentityProvider.txt | 2 +- ...entication-getIdentityProviderMetadata.txt | 2 +- ...federatedAuthentication-getRoleMapping.txt | 2 +- ...Authentication-listConnectedOrgConfigs.txt | 2 +- ...edAuthentication-listIdentityProviders.txt | 2 +- ...deratedAuthentication-listRoleMappings.txt | 2 +- ...uthentication-removeConnectedOrgConfig.txt | 2 +- ...ication-revokeJwksFromIdentityProvider.txt | 2 +- ...uthentication-updateConnectedOrgConfig.txt | 2 +- ...dAuthentication-updateIdentityProvider.txt | 2 +- ...eratedAuthentication-updateRoleMapping.txt | 2 +- .../atlas-api-federatedAuthentication.txt | 38 +++---- ...las-api-flexClusters-createFlexCluster.txt | 2 +- ...las-api-flexClusters-deleteFlexCluster.txt | 2 +- .../atlas-api-flexClusters-getFlexCluster.txt | 2 +- ...tlas-api-flexClusters-listFlexClusters.txt | 2 +- ...las-api-flexClusters-updateFlexCluster.txt | 2 +- ...as-api-flexClusters-upgradeFlexCluster.txt | 2 +- docs/command/atlas-api-flexClusters.txt | 14 +-- ...RestoreJobs-createFlexBackupRestoreJob.txt | 2 +- ...lexRestoreJobs-getFlexBackupRestoreJob.txt | 2 +- ...xRestoreJobs-listFlexBackupRestoreJobs.txt | 2 +- docs/command/atlas-api-flexRestoreJobs.txt | 8 +- ...s-api-flexSnapshots-downloadFlexBackup.txt | 2 +- .../atlas-api-flexSnapshots-getFlexBackup.txt | 2 +- ...tlas-api-flexSnapshots-listFlexBackups.txt | 2 +- docs/command/atlas-api-flexSnapshots.txt | 8 +- ...globalClusters-createCustomZoneMapping.txt | 2 +- ...-globalClusters-createManagedNamespace.txt | 2 +- ...alClusters-deleteAllCustomZoneMappings.txt | 2 +- ...-globalClusters-deleteManagedNamespace.txt | 2 +- ...api-globalClusters-getManagedNamespace.txt | 2 +- docs/command/atlas-api-globalClusters.txt | 12 +-- ...nvoices-createCostExplorerQueryProcess.txt | 2 +- .../atlas-api-invoices-downloadInvoiceCsv.txt | 2 +- ...i-invoices-getCostExplorerQueryProcess.txt | 2 +- .../command/atlas-api-invoices-getInvoice.txt | 2 +- .../atlas-api-invoices-listInvoices.txt | 2 +- ...atlas-api-invoices-listPendingInvoices.txt | 2 +- ...voices-queryLineItemsFromSingleInvoice.txt | 2 +- docs/command/atlas-api-invoices.txt | 16 +-- ...pConfiguration-deleteLdapConfiguration.txt | 2 +- ...ldapConfiguration-getLdapConfiguration.txt | 2 +- ...nfiguration-getLdapConfigurationStatus.txt | 2 +- ...dapConfiguration-saveLdapConfiguration.txt | 2 +- ...pConfiguration-verifyLdapConfiguration.txt | 2 +- docs/command/atlas-api-ldapConfiguration.txt | 12 +-- ...acyBackup-createLegacyBackupRestoreJob.txt | 2 +- ...-api-legacyBackup-deleteLegacySnapshot.txt | 2 +- ...legacyBackup-getLegacyBackupCheckpoint.txt | 2 +- ...legacyBackup-getLegacyBackupRestoreJob.txt | 2 +- ...las-api-legacyBackup-getLegacySnapshot.txt | 2 +- ...legacyBackup-getLegacySnapshotSchedule.txt | 2 +- ...gacyBackup-listLegacyBackupCheckpoints.txt | 2 +- ...gacyBackup-listLegacyBackupRestoreJobs.txt | 2 +- ...s-api-legacyBackup-listLegacySnapshots.txt | 2 +- ...cyBackup-updateLegacySnapshotRetention.txt | 2 +- ...acyBackup-updateLegacySnapshotSchedule.txt | 2 +- docs/command/atlas-api-legacyBackup.txt | 24 ++--- ...ntenanceWindows-deferMaintenanceWindow.txt | 2 +- ...aintenanceWindows-getMaintenanceWindow.txt | 2 +- ...ntenanceWindows-resetMaintenanceWindow.txt | 2 +- ...anceWindows-toggleMaintenanceAutoDefer.txt | 2 +- ...tenanceWindows-updateMaintenanceWindow.txt | 2 +- docs/command/atlas-api-maintenanceWindows.txt | 12 +-- ...-mongoDbCloudUsers-addOrganizationRole.txt | 2 +- ...s-api-mongoDbCloudUsers-addProjectRole.txt | 2 +- ...s-api-mongoDbCloudUsers-addProjectUser.txt | 2 +- ...as-api-mongoDbCloudUsers-addUserToTeam.txt | 2 +- ...ngoDbCloudUsers-createOrganizationUser.txt | 2 +- ...atlas-api-mongoDbCloudUsers-createUser.txt | 2 +- ...-mongoDbCloudUsers-getOrganizationUser.txt | 2 +- ...s-api-mongoDbCloudUsers-getProjectUser.txt | 2 +- .../atlas-api-mongoDbCloudUsers-getUser.txt | 2 +- ...pi-mongoDbCloudUsers-getUserByUsername.txt | 2 +- ...ongoDbCloudUsers-listOrganizationUsers.txt | 2 +- ...api-mongoDbCloudUsers-listProjectUsers.txt | 2 +- ...as-api-mongoDbCloudUsers-listTeamUsers.txt | 2 +- ...ngoDbCloudUsers-removeOrganizationRole.txt | 2 +- ...ngoDbCloudUsers-removeOrganizationUser.txt | 2 +- ...pi-mongoDbCloudUsers-removeProjectRole.txt | 2 +- ...pi-mongoDbCloudUsers-removeProjectUser.txt | 2 +- ...i-mongoDbCloudUsers-removeUserFromTeam.txt | 2 +- ...ngoDbCloudUsers-updateOrganizationUser.txt | 2 +- docs/command/atlas-api-mongoDbCloudUsers.txt | 40 +++---- ...-api-monitoringAndLogs-getAtlasProcess.txt | 2 +- ...tlas-api-monitoringAndLogs-getDatabase.txt | 2 +- ...itoringAndLogs-getDatabaseMeasurements.txt | 2 +- ...-monitoringAndLogs-getDiskMeasurements.txt | 2 +- ...tlas-api-monitoringAndLogs-getHostLogs.txt | 2 +- ...-monitoringAndLogs-getHostMeasurements.txt | 2 +- ...-api-monitoringAndLogs-getIndexMetrics.txt | 2 +- ...-api-monitoringAndLogs-getMeasurements.txt | 2 +- ...i-monitoringAndLogs-listAtlasProcesses.txt | 2 +- ...as-api-monitoringAndLogs-listDatabases.txt | 2 +- ...monitoringAndLogs-listDiskMeasurements.txt | 2 +- ...i-monitoringAndLogs-listDiskPartitions.txt | 2 +- ...api-monitoringAndLogs-listIndexMetrics.txt | 2 +- ...-api-monitoringAndLogs-listMetricTypes.txt | 2 +- docs/command/atlas-api-monitoringAndLogs.txt | 30 +++--- ...networkPeering-createPeeringConnection.txt | 2 +- ...-networkPeering-createPeeringContainer.txt | 2 +- ...networkPeering-deletePeeringConnection.txt | 2 +- ...-networkPeering-deletePeeringContainer.txt | 2 +- ...tlas-api-networkPeering-disablePeering.txt | 2 +- ...pi-networkPeering-getPeeringConnection.txt | 2 +- ...api-networkPeering-getPeeringContainer.txt | 2 +- ...-networkPeering-listPeeringConnections.txt | 2 +- ...ng-listPeeringContainerByCloudProvider.txt | 2 +- ...i-networkPeering-listPeeringContainers.txt | 2 +- ...networkPeering-updatePeeringConnection.txt | 2 +- ...-networkPeering-updatePeeringContainer.txt | 2 +- ...ConnectViaPeeringOnlyModeForOneProject.txt | 2 +- docs/command/atlas-api-networkPeering.txt | 28 ++--- ...-api-onlineArchive-createOnlineArchive.txt | 2 +- ...-api-onlineArchive-deleteOnlineArchive.txt | 2 +- ...Archive-downloadOnlineArchiveQueryLogs.txt | 2 +- ...las-api-onlineArchive-getOnlineArchive.txt | 2 +- ...s-api-onlineArchive-listOnlineArchives.txt | 2 +- ...-api-onlineArchive-updateOnlineArchive.txt | 2 +- docs/command/atlas-api-onlineArchive.txt | 14 +-- ...s-api-organizations-createOrganization.txt | 2 +- ...nizations-createOrganizationInvitation.txt | 2 +- ...s-api-organizations-deleteOrganization.txt | 2 +- ...nizations-deleteOrganizationInvitation.txt | 2 +- ...tlas-api-organizations-getOrganization.txt | 2 +- ...rganizations-getOrganizationInvitation.txt | 2 +- ...-organizations-getOrganizationSettings.txt | 2 +- ...anizations-listOrganizationInvitations.txt | 2 +- ...organizations-listOrganizationProjects.txt | 2 +- ...as-api-organizations-listOrganizations.txt | 2 +- ...s-api-organizations-updateOrganization.txt | 2 +- ...nizations-updateOrganizationInvitation.txt | 2 +- ...tions-updateOrganizationInvitationById.txt | 2 +- ...-organizations-updateOrganizationRoles.txt | 2 +- ...ganizations-updateOrganizationSettings.txt | 2 +- docs/command/atlas-api-organizations.txt | 32 +++--- ...visor-disableSlowOperationThresholding.txt | 2 +- ...dvisor-enableSlowOperationThresholding.txt | 2 +- ...pi-performanceAdvisor-getManagedSlowMs.txt | 2 +- ...manceAdvisor-getServerlessAutoIndexing.txt | 2 +- ...nceAdvisor-listClusterSuggestedIndexes.txt | 2 +- ...api-performanceAdvisor-listDropIndexes.txt | 2 +- ...pi-performanceAdvisor-listSchemaAdvice.txt | 2 +- ...api-performanceAdvisor-listSlowQueries.txt | 2 +- ...ormanceAdvisor-listSlowQueryNamespaces.txt | 2 +- ...erformanceAdvisor-listSuggestedIndexes.txt | 2 +- ...manceAdvisor-setServerlessAutoIndexing.txt | 2 +- docs/command/atlas-api-performanceAdvisor.txt | 24 ++--- ...EndpointServices-createPrivateEndpoint.txt | 2 +- ...tServices-createPrivateEndpointService.txt | 2 +- ...EndpointServices-deletePrivateEndpoint.txt | 2 +- ...tServices-deletePrivateEndpointService.txt | 2 +- ...ateEndpointServices-getPrivateEndpoint.txt | 2 +- ...ointServices-getPrivateEndpointService.txt | 2 +- ...-getRegionalizedPrivateEndpointSetting.txt | 2 +- ...ntServices-listPrivateEndpointServices.txt | 2 +- ...ggleRegionalizedPrivateEndpointSetting.txt | 2 +- .../atlas-api-privateEndpointServices.txt | 20 ++-- ...i-programmaticApiKeys-addProjectApiKey.txt | 2 +- ...s-api-programmaticApiKeys-createApiKey.txt | 2 +- ...rammaticApiKeys-createApiKeyAccessList.txt | 2 +- ...rogrammaticApiKeys-createProjectApiKey.txt | 2 +- ...s-api-programmaticApiKeys-deleteApiKey.txt | 2 +- ...ticApiKeys-deleteApiKeyAccessListEntry.txt | 2 +- ...tlas-api-programmaticApiKeys-getApiKey.txt | 2 +- ...rogrammaticApiKeys-getApiKeyAccessList.txt | 2 +- ...icApiKeys-listApiKeyAccessListsEntries.txt | 2 +- ...as-api-programmaticApiKeys-listApiKeys.txt | 2 +- ...programmaticApiKeys-listProjectApiKeys.txt | 2 +- ...rogrammaticApiKeys-removeProjectApiKey.txt | 2 +- ...s-api-programmaticApiKeys-updateApiKey.txt | 2 +- ...-programmaticApiKeys-updateApiKeyRoles.txt | 2 +- .../command/atlas-api-programmaticApiKeys.txt | 30 +++--- ...IpAccessList-createProjectIpAccessList.txt | 2 +- ...IpAccessList-deleteProjectIpAccessList.txt | 2 +- ...ccessList-getProjectIpAccessListStatus.txt | 2 +- ...i-projectIpAccessList-getProjectIpList.txt | 2 +- ...tIpAccessList-listProjectIpAccessLists.txt | 2 +- .../command/atlas-api-projectIpAccessList.txt | 12 +-- .../atlas-api-projects-addUserToProject.txt | 2 +- .../atlas-api-projects-createProject.txt | 2 +- ...s-api-projects-createProjectInvitation.txt | 2 +- .../atlas-api-projects-deleteProject.txt | 2 +- ...s-api-projects-deleteProjectInvitation.txt | 2 +- .../atlas-api-projects-deleteProjectLimit.txt | 2 +- .../command/atlas-api-projects-getProject.txt | 2 +- .../atlas-api-projects-getProjectByName.txt | 2 +- ...tlas-api-projects-getProjectInvitation.txt | 2 +- .../atlas-api-projects-getProjectLimit.txt | 2 +- ...las-api-projects-getProjectLtsVersions.txt | 2 +- .../atlas-api-projects-getProjectSettings.txt | 2 +- ...as-api-projects-listProjectInvitations.txt | 2 +- .../atlas-api-projects-listProjectLimits.txt | 2 +- .../atlas-api-projects-listProjects.txt | 2 +- ...pi-projects-migrateProjectToAnotherOrg.txt | 2 +- ...tlas-api-projects-returnAllIpAddresses.txt | 2 +- .../atlas-api-projects-setProjectLimit.txt | 2 +- .../atlas-api-projects-updateProject.txt | 2 +- ...s-api-projects-updateProjectInvitation.txt | 2 +- ...i-projects-updateProjectInvitationById.txt | 2 +- .../atlas-api-projects-updateProjectRoles.txt | 2 +- ...las-api-projects-updateProjectSettings.txt | 2 +- docs/command/atlas-api-projects.txt | 48 ++++----- ...Export-createPushBasedLogConfiguration.txt | 2 +- ...Export-deletePushBasedLogConfiguration.txt | 2 +- ...LogExport-getPushBasedLogConfiguration.txt | 2 +- ...Export-updatePushBasedLogConfiguration.txt | 2 +- docs/command/atlas-api-pushBasedLogExport.txt | 10 +- ...urcePolicies-createAtlasResourcePolicy.txt | 2 +- ...urcePolicies-deleteAtlasResourcePolicy.txt | 2 +- ...ourcePolicies-getAtlasResourcePolicies.txt | 2 +- ...esourcePolicies-getAtlasResourcePolicy.txt | 2 +- ...ourcePolicies-getResourcesNonCompliant.txt | 2 +- ...urcePolicies-updateAtlasResourcePolicy.txt | 2 +- ...cePolicies-validateAtlasResourcePolicy.txt | 2 +- docs/command/atlas-api-resourcePolicies.txt | 16 +-- ...as-api-rollingIndex-createRollingIndex.txt | 2 +- docs/command/atlas-api-rollingIndex.txt | 4 +- .../atlas-api-root-getSystemStatus.txt | 2 +- ...-root-returnAllControlPlaneIpAddresses.txt | 2 +- docs/command/atlas-api-root.txt | 6 +- ...lessInstances-createServerlessInstance.txt | 2 +- ...lessInstances-deleteServerlessInstance.txt | 2 +- ...verlessInstances-getServerlessInstance.txt | 2 +- ...rlessInstances-listServerlessInstances.txt | 2 +- ...lessInstances-updateServerlessInstance.txt | 2 +- .../command/atlas-api-serverlessInstances.txt | 12 +-- ...points-createServerlessPrivateEndpoint.txt | 2 +- ...points-deleteServerlessPrivateEndpoint.txt | 2 +- ...Endpoints-getServerlessPrivateEndpoint.txt | 2 +- ...dpoints-listServerlessPrivateEndpoints.txt | 2 +- ...points-updateServerlessPrivateEndpoint.txt | 2 +- .../atlas-api-serverlessPrivateEndpoints.txt | 12 +-- ...rviceAccounts-addProjectServiceAccount.txt | 2 +- ...ceAccounts-createProjectServiceAccount.txt | 2 +- ...-createProjectServiceAccountAccessList.txt | 2 +- ...unts-createProjectServiceAccountSecret.txt | 2 +- ...i-serviceAccounts-createServiceAccount.txt | 2 +- ...ccounts-createServiceAccountAccessList.txt | 2 +- ...iceAccounts-createServiceAccountSecret.txt | 2 +- ...ceAccounts-deleteProjectServiceAccount.txt | 2 +- ...teProjectServiceAccountAccessListEntry.txt | 2 +- ...unts-deleteProjectServiceAccountSecret.txt | 2 +- ...i-serviceAccounts-deleteServiceAccount.txt | 2 +- ...ts-deleteServiceAccountAccessListEntry.txt | 2 +- ...iceAccounts-deleteServiceAccountSecret.txt | 2 +- ...rviceAccounts-getProjectServiceAccount.txt | 2 +- ...-api-serviceAccounts-getServiceAccount.txt | 2 +- ...ts-listProjectServiceAccountAccessList.txt | 2 +- ...iceAccounts-listProjectServiceAccounts.txt | 2 +- ...eAccounts-listServiceAccountAccessList.txt | 2 +- ...iceAccounts-listServiceAccountProjects.txt | 2 +- ...pi-serviceAccounts-listServiceAccounts.txt | 2 +- ...ceAccounts-updateProjectServiceAccount.txt | 2 +- ...i-serviceAccounts-updateServiceAccount.txt | 2 +- docs/command/atlas-api-serviceAccounts.txt | 46 ++++---- ...bs-createSharedClusterBackupRestoreJob.txt | 2 +- ...eJobs-getSharedClusterBackupRestoreJob.txt | 2 +- ...obs-listSharedClusterBackupRestoreJobs.txt | 2 +- .../atlas-api-sharedTierRestoreJobs.txt | 8 +- ...rSnapshots-downloadSharedClusterBackup.txt | 2 +- ...edTierSnapshots-getSharedClusterBackup.txt | 2 +- ...TierSnapshots-listSharedClusterBackups.txt | 2 +- .../command/atlas-api-sharedTierSnapshots.txt | 8 +- ...api-streams-acceptVpcPeeringConnection.txt | 2 +- ...pi-streams-createPrivateLinkConnection.txt | 2 +- ...las-api-streams-createStreamConnection.txt | 2 +- ...atlas-api-streams-createStreamInstance.txt | 2 +- ...ateStreamInstanceWithSampleConnections.txt | 2 +- ...tlas-api-streams-createStreamProcessor.txt | 2 +- ...pi-streams-deletePrivateLinkConnection.txt | 2 +- ...las-api-streams-deleteStreamConnection.txt | 2 +- ...atlas-api-streams-deleteStreamInstance.txt | 2 +- ...tlas-api-streams-deleteStreamProcessor.txt | 2 +- ...api-streams-deleteVpcPeeringConnection.txt | 2 +- ...-streams-downloadStreamTenantAuditLogs.txt | 2 +- .../atlas-api-streams-getAccountDetails.txt | 2 +- ...streams-getActiveVpcPeeringConnections.txt | 2 +- ...s-api-streams-getPrivateLinkConnection.txt | 2 +- .../atlas-api-streams-getStreamConnection.txt | 2 +- .../atlas-api-streams-getStreamInstance.txt | 2 +- .../atlas-api-streams-getStreamProcessor.txt | 2 +- ...s-api-streams-getVpcPeeringConnections.txt | 2 +- ...api-streams-listPrivateLinkConnections.txt | 2 +- ...tlas-api-streams-listStreamConnections.txt | 2 +- .../atlas-api-streams-listStreamInstances.txt | 2 +- ...atlas-api-streams-listStreamProcessors.txt | 2 +- ...tlas-api-streams-modifyStreamProcessor.txt | 2 +- ...api-streams-rejectVpcPeeringConnection.txt | 2 +- ...atlas-api-streams-startStreamProcessor.txt | 2 +- ...s-api-streams-startStreamProcessorWith.txt | 2 +- .../atlas-api-streams-stopStreamProcessor.txt | 2 +- ...las-api-streams-updateStreamConnection.txt | 2 +- ...atlas-api-streams-updateStreamInstance.txt | 2 +- docs/command/atlas-api-streams.txt | 62 +++++------ .../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-getTeamById.txt | 2 +- .../command/atlas-api-teams-getTeamByName.txt | 2 +- .../atlas-api-teams-listOrganizationTeams.txt | 2 +- .../atlas-api-teams-listProjectTeams.txt | 2 +- .../atlas-api-teams-removeProjectTeam.txt | 2 +- .../atlas-api-teams-removeTeamUser.txt | 2 +- docs/command/atlas-api-teams-renameTeam.txt | 2 +- .../atlas-api-teams-updateTeamRoles.txt | 2 +- docs/command/atlas-api-teams.txt | 26 ++--- ...tegrations-createThirdPartyIntegration.txt | 2 +- ...tegrations-deleteThirdPartyIntegration.txt | 2 +- ...yIntegrations-getThirdPartyIntegration.txt | 2 +- ...ntegrations-listThirdPartyIntegrations.txt | 2 +- ...tegrations-updateThirdPartyIntegration.txt | 2 +- .../atlas-api-thirdPartyIntegrations.txt | 12 +-- ...tication-createDatabaseUserCertificate.txt | 2 +- ...hentication-disableCustomerManagedX509.txt | 2 +- ...ntication-listDatabaseUserCertificates.txt | 2 +- docs/command/atlas-api-x509Authentication.txt | 8 +- docs/command/atlas-api.txt | 102 +++++++++--------- docs/command/atlas.txt | 2 +- internal/cli/api/api.go | 2 +- tools/cmd/docs/transformations.go | 2 +- 506 files changed, 1008 insertions(+), 1008 deletions(-) diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt index 8080d2d818..ba8fbe5f34 100644 --- a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt +++ b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt @@ -12,7 +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.Returns the access logs of one cluster identified by the cluster's name. +`Public Preview: please provide feedback `_: Returns the access logs of one cluster identified by the cluster's name. 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. diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt index 8a4332b7ec..85fec22650 100644 --- a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt +++ b/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt @@ -12,7 +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.Returns the access logs of one cluster identified by the cluster's hostname. +`Public Preview: please provide feedback `_: Returns the access logs of one cluster identified by the cluster's hostname. 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. diff --git a/docs/command/atlas-api-accessTracking.txt b/docs/command/atlas-api-accessTracking.txt index 3d76641081..0ebddc346b 100644 --- a/docs/command/atlas-api-accessTracking.txt +++ b/docs/command/atlas-api-accessTracking.txt @@ -12,7 +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.Returns access logs for authentication attempts made to Atlas database deployments. +`Public Preview: please provide feedback `_: Returns access logs for authentication attempts made to Atlas database deployments. 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. @@ -56,8 +56,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.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.Returns the access logs of one cluster identified by the cluster's hostname. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt index 967e801241..ce4f8469d7 100644 --- a/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt @@ -12,7 +12,7 @@ atlas api alertConfigurations createAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one alert configuration for the specified project.Creates one alert configuration for the specified project. +`Public Preview: please provide feedback `_: Creates one alert configuration for the specified project. 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. diff --git a/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt index 7e5c310988..d1812f59e2 100644 --- a/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt @@ -12,7 +12,7 @@ atlas api alertConfigurations deleteAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one alert configuration from the specified project.Removes one alert configuration from the specified project. +`Public Preview: please provide feedback `_: Removes one alert configuration from the specified project. 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. diff --git a/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt index d1c0149286..0bcfc10cd3 100644 --- a/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt @@ -12,7 +12,7 @@ atlas api alertConfigurations getAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the specified alert configuration from the specified project.Returns the specified alert configuration from the specified project. +`Public Preview: please provide feedback `_: Returns the specified alert configuration from the specified project. 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. diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt index 1a614a2925..55763db4a6 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt @@ -12,7 +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.Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. +`Public Preview: please provide feedback `_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. 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. diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt index 0e586a0ae3..e9ff08b2d2 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt @@ -12,7 +12,7 @@ atlas api alertConfigurations listAlertConfigurations :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all alert configurations for one project.Returns all alert configurations for one project. +`Public Preview: please provide feedback `_: Returns all alert configurations for one project. 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. diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt index a2857454c1..0b40174280 100644 --- a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt +++ b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt @@ -12,7 +12,7 @@ atlas api alertConfigurations listAlertConfigurationsByAlertId :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all alert configurations set for the specified alert.Returns all alert configurations set for the specified alert. +`Public Preview: please provide feedback `_: Returns all alert configurations set for the specified alert. 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. diff --git a/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt index c1df68eb05..63e5f1c8b2 100644 --- a/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt @@ -12,7 +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.Enables or disables the specified alert configuration in the specified project. +`Public Preview: please provide feedback `_: Enables or disables the specified alert configuration in the specified project. 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. diff --git a/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt index 2013ae4849..d290cde056 100644 --- a/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt +++ b/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt @@ -12,7 +12,7 @@ atlas api alertConfigurations updateAlertConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one alert configuration in the specified project.Updates one alert configuration in the specified project. +`Public Preview: please provide feedback `_: Updates one alert configuration in the specified project. 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. diff --git a/docs/command/atlas-api-alertConfigurations.txt b/docs/command/atlas-api-alertConfigurations.txt index 4d6317ebe5..094904ce1f 100644 --- a/docs/command/atlas-api-alertConfigurations.txt +++ b/docs/command/atlas-api-alertConfigurations.txt @@ -12,7 +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.Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. +`Public Preview: please provide feedback `_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. 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. @@ -56,14 +56,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - `Public Preview: please provide feedback `_: Creates one alert configuration for the specified project.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.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.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.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.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.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.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.Updates one alert configuration in the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-alerts-acknowledgeAlert.txt b/docs/command/atlas-api-alerts-acknowledgeAlert.txt index c1a328a4b2..4bee277869 100644 --- a/docs/command/atlas-api-alerts-acknowledgeAlert.txt +++ b/docs/command/atlas-api-alerts-acknowledgeAlert.txt @@ -12,7 +12,7 @@ atlas api alerts acknowledgeAlert :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Confirms receipt of one existing alert.Confirms receipt of one existing alert. +`Public Preview: please provide feedback `_: Confirms receipt of one existing alert. 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. diff --git a/docs/command/atlas-api-alerts-getAlert.txt b/docs/command/atlas-api-alerts-getAlert.txt index 14bd295aa3..ac0bf3d434 100644 --- a/docs/command/atlas-api-alerts-getAlert.txt +++ b/docs/command/atlas-api-alerts-getAlert.txt @@ -12,7 +12,7 @@ atlas api alerts getAlert :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one alert.Returns one alert. +`Public Preview: please provide feedback `_: Returns one alert. 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. diff --git a/docs/command/atlas-api-alerts-listAlerts.txt b/docs/command/atlas-api-alerts-listAlerts.txt index 6676be29df..deb7de30bf 100644 --- a/docs/command/atlas-api-alerts-listAlerts.txt +++ b/docs/command/atlas-api-alerts-listAlerts.txt @@ -12,7 +12,7 @@ atlas api alerts listAlerts :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all alerts.Returns all alerts. +`Public Preview: please provide feedback `_: Returns all alerts. 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. diff --git a/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt b/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt index ef4ef06a5b..cca9aa4f4d 100644 --- a/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt +++ b/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt @@ -12,7 +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.Returns all open alerts that the specified alert configuration triggers. +`Public Preview: please provide feedback `_: Returns all open alerts that the specified alert configuration triggers. 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. diff --git a/docs/command/atlas-api-alerts.txt b/docs/command/atlas-api-alerts.txt index dbf009a079..ac8b7cc15c 100644 --- a/docs/command/atlas-api-alerts.txt +++ b/docs/command/atlas-api-alerts.txt @@ -12,7 +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.Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. +`Public Preview: please provide feedback `_: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. 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. @@ -56,10 +56,10 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alerts-acknowledgeAlert` - `Public Preview: please provide feedback `_: Confirms receipt of one existing alert.Confirms receipt of one existing alert. -* :ref:`atlas-api-alerts-getAlert` - `Public Preview: please provide feedback `_: Returns one alert.Returns one alert. -* :ref:`atlas-api-alerts-listAlerts` - `Public Preview: please provide feedback `_: Returns all alerts.Returns all alerts. -* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - `Public Preview: please provide feedback `_: Returns all open alerts that the specified alert configuration triggers.Returns all open alerts that the specified alert configuration triggers. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt index 8b70f71ffc..be212d4f97 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt @@ -12,7 +12,7 @@ atlas api atlasSearch createAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates Search Nodes for the specified cluster.Creates Search Nodes for the specified cluster. +`Public Preview: please provide feedback `_: Creates Search Nodes for the specified cluster. 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. diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt index bf92f3c6a3..fb7b9477a8 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt @@ -12,7 +12,7 @@ atlas api atlasSearch createAtlasSearchIndex :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one Atlas Search index on the specified collection.Creates one Atlas Search index on the specified collection. +`Public Preview: please provide feedback `_: Creates one Atlas Search index on the specified collection. 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. diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt index e023e6c910..4f20178ee9 100644 --- a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt @@ -12,7 +12,7 @@ atlas api atlasSearch createAtlasSearchIndexDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one Atlas Search index on the specified collection.Creates one Atlas Search index on the specified collection. +`Public Preview: please provide feedback `_: Creates one Atlas Search index on the specified collection. 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. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt index 2def549fc7..ed6205f9e1 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt @@ -12,7 +12,7 @@ atlas api atlasSearch deleteAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes the Search Nodes for the specified cluster.Deletes the Search Nodes for the specified cluster. +`Public Preview: please provide feedback `_: Deletes the Search Nodes for the specified cluster. 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. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt index 5021ff97e4..f70bf8d6a6 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndex.txt @@ -12,7 +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.Removes one Atlas Search index that you identified with its unique ID. +`Public Preview: please provide feedback `_: Removes one Atlas Search index that you identified with its unique ID. 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. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt index e0c46edff3..fee20ac611 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt @@ -12,7 +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.Removes one Atlas Search index that you identified with its database, collection, and name. +`Public Preview: please provide feedback `_: Removes one Atlas Search index that you identified with its database, collection, and name. 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. diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt index 6f3743feeb..6b1254ebe6 100644 --- a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt @@ -12,7 +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.Removes one Atlas Search index that you identified with its unique ID. +`Public Preview: please provide feedback `_: Removes one Atlas Search index that you identified with its unique ID. 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. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt index 60d4b4a609..6525be7883 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt @@ -12,7 +12,7 @@ atlas api atlasSearch getAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the Search Nodes for the specified cluster.Returns the Search Nodes for the specified cluster. +`Public Preview: please provide feedback `_: Returns the Search Nodes for the specified cluster. 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. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt index 07d33dd318..721ec27bde 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndex.txt @@ -12,7 +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.Returns one Atlas Search index that you identified with its unique ID. +`Public Preview: please provide feedback `_: Returns one Atlas Search index that you identified with its unique ID. 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. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt index 797de038ce..912b8381a1 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt @@ -12,7 +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.Returns one Atlas Search index that you identified with its database, collection name, and index name. +`Public Preview: please provide feedback `_: Returns one Atlas Search index that you identified with its database, collection name, and index name. 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. diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt index 34ebff3629..a13af36f02 100644 --- a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt @@ -12,7 +12,7 @@ atlas api atlasSearch getAtlasSearchIndexDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one Atlas Search index in the specified project.Returns one Atlas Search index in the specified project. +`Public Preview: please provide feedback `_: Returns one Atlas Search index in the specified project. 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. diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt index a1a4328f74..0ce7091af3 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt @@ -12,7 +12,7 @@ atlas api atlasSearch listAtlasSearchIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified collection.Returns all Atlas Search indexes on the specified collection. +`Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified collection. 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. diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt index e8ce08f1a6..f40f10ae70 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt @@ -12,7 +12,7 @@ atlas api atlasSearch listAtlasSearchIndexesCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified cluster.Returns all Atlas Search indexes on the specified cluster. +`Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified cluster. 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. diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt index a436ed03e5..6ab40e4498 100644 --- a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt @@ -12,7 +12,7 @@ atlas api atlasSearch listAtlasSearchIndexesDeprecated :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified collection.Returns all Atlas Search indexes on the specified collection. +`Public Preview: please provide feedback `_: Returns all Atlas Search indexes on the specified collection. 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. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt index 1ad64e44d6..7f87829b3f 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt @@ -12,7 +12,7 @@ atlas api atlasSearch updateAtlasSearchDeployment :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the Search Nodes for the specified cluster.Updates the Search Nodes for the specified cluster. +`Public Preview: please provide feedback `_: Updates the Search Nodes for the specified cluster. 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. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt index 2c5ce902b4..836c5b44e6 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt @@ -12,7 +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.Updates one Atlas Search index that you identified with its unique ID. +`Public Preview: please provide feedback `_: Updates one Atlas Search index that you identified with its unique ID. 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. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt index 57b1335899..c3bccba1b9 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt @@ -12,7 +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.Updates one Atlas Search index that you identified with its database, collection name, and index name. +`Public Preview: please provide feedback `_: Updates one Atlas Search index that you identified with its database, collection name, and index name. 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. diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt index ec2fdccccf..84b342c703 100644 --- a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt +++ b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt @@ -12,7 +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.Updates one Atlas Search index that you identified with its unique ID. +`Public Preview: please provide feedback `_: Updates one Atlas Search index that you identified with its unique ID. 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. diff --git a/docs/command/atlas-api-atlasSearch.txt b/docs/command/atlas-api-atlasSearch.txt index b220e13029..8ce859650f 100644 --- a/docs/command/atlas-api-atlasSearch.txt +++ b/docs/command/atlas-api-atlasSearch.txt @@ -12,7 +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.Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. 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. @@ -56,24 +56,24 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-atlasSearch-createAtlasSearchDeployment` - `Public Preview: please provide feedback `_: Creates Search Nodes for the specified cluster.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.Updates one Atlas Search index that you identified with its unique ID. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-auditing-getAuditingConfiguration.txt b/docs/command/atlas-api-auditing-getAuditingConfiguration.txt index 83fb3d0b6a..3f43c39e0a 100644 --- a/docs/command/atlas-api-auditing-getAuditingConfiguration.txt +++ b/docs/command/atlas-api-auditing-getAuditingConfiguration.txt @@ -12,7 +12,7 @@ atlas api auditing getAuditingConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the auditing configuration for the specified project.Returns the auditing configuration for the specified project. +`Public Preview: please provide feedback `_: Returns the auditing configuration for the specified project. 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. diff --git a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt b/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt index 683391db43..a8a8c01dbe 100644 --- a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt +++ b/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt @@ -12,7 +12,7 @@ atlas api auditing updateAuditingConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the auditing configuration for the specified project.Updates the auditing configuration for the specified project. +`Public Preview: please provide feedback `_: Updates the auditing configuration for the specified project. 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. diff --git a/docs/command/atlas-api-auditing.txt b/docs/command/atlas-api-auditing.txt index 78a75fa0ac..26b4564a7f 100644 --- a/docs/command/atlas-api-auditing.txt +++ b/docs/command/atlas-api-auditing.txt @@ -12,7 +12,7 @@ atlas api auditing :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns and edits database auditing settings for MongoDB Cloud projects.Returns and edits database auditing settings for MongoDB Cloud projects. +`Public Preview: please provide feedback `_: Returns and edits database auditing settings for MongoDB Cloud projects. 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. @@ -56,8 +56,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-auditing-getAuditingConfiguration` - `Public Preview: please provide feedback `_: Returns the auditing configuration for the specified project.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.Updates the auditing configuration for the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt b/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt index abeb3bae75..926f2f45a4 100644 --- a/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt +++ b/docs/command/atlas-api-awsClustersDns-getAwsCustomDns.txt @@ -12,7 +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.Returns the custom DNS configuration for AWS clusters in the specified project. +`Public Preview: please provide feedback `_: Returns the custom DNS configuration for AWS clusters in the specified project. 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. diff --git a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt index 0c7e0f9b06..d7ed862db7 100644 --- a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt +++ b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt @@ -12,7 +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.Enables or disables the custom DNS configuration for AWS clusters in the specified project. +`Public Preview: please provide feedback `_: Enables or disables the custom DNS configuration for AWS clusters in the specified project. 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. diff --git a/docs/command/atlas-api-awsClustersDns.txt b/docs/command/atlas-api-awsClustersDns.txt index 3df27fbe19..9dfe02b19e 100644 --- a/docs/command/atlas-api-awsClustersDns.txt +++ b/docs/command/atlas-api-awsClustersDns.txt @@ -12,7 +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.Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. +`Public Preview: please provide feedback `_: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. 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. @@ -56,8 +56,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.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.Enables or disables the custom DNS configuration for AWS clusters in the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt index 9ae80039ef..9d1c95afa8 100644 --- a/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-cancelBackupRestoreJob.txt @@ -12,7 +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.Cancels one cloud backup restore job of one cluster from the specified project. +`Public Preview: please provide feedback `_: Cancels one cloud backup restore job of one cluster from the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt index f133d2a6ee..1c20672ecc 100644 --- a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt +++ b/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt @@ -12,7 +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.Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. +`Public Preview: please provide feedback `_: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. 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. diff --git a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt index 7599009a16..b621bb9a0b 100644 --- a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt @@ -12,7 +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.Restores one snapshot of one cluster from the specified project. +`Public Preview: please provide feedback `_: Restores one snapshot of one cluster from the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups-createExportBucket.txt b/docs/command/atlas-api-cloudBackups-createExportBucket.txt index 1cb742c2f8..7bfb27a691 100644 --- a/docs/command/atlas-api-cloudBackups-createExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-createExportBucket.txt @@ -12,7 +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.Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. +`Public Preview: please provide feedback `_: Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. 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. diff --git a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt index 3fbeb06a1b..ed02cafbfe 100644 --- a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt @@ -12,7 +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.Restores one snapshot of one serverless instance from the specified project. +`Public Preview: please provide feedback `_: Restores one snapshot of one serverless instance from the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt b/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt index 7f0e3f048e..a54441c65e 100644 --- a/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt +++ b/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt @@ -12,7 +12,7 @@ atlas api cloudBackups deleteAllBackupSchedules :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes all cloud backup schedules for the specified cluster.Removes all cloud backup schedules for the specified cluster. +`Public Preview: please provide feedback `_: Removes all cloud backup schedules for the specified cluster. 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. diff --git a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt index 8434394055..65e7e0d980 100644 --- a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt @@ -12,7 +12,7 @@ atlas api cloudBackups deleteExportBucket :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes an Export Bucket.Deletes an Export Bucket. +`Public Preview: please provide feedback `_: Deletes an Export Bucket. 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. diff --git a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt index d6a6dec583..256ea21964 100644 --- a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt +++ b/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt @@ -12,7 +12,7 @@ atlas api cloudBackups deleteReplicaSetBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes the specified snapshot.Removes the specified snapshot. +`Public Preview: please provide feedback `_: Removes the specified snapshot. 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. diff --git a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt index 943ac07ed6..8b316e828d 100644 --- a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt +++ b/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt @@ -12,7 +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.Removes one snapshot of one sharded cluster from the specified project. +`Public Preview: please provide feedback `_: Removes one snapshot of one sharded cluster from the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt index 380e52b837..72ff027b09 100644 --- a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt @@ -12,7 +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.Disables the Backup Compliance Policy settings with the specified project. +`Public Preview: please provide feedback `_: Disables the Backup Compliance Policy settings with the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt index dc261717b4..bb7c509dae 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt @@ -12,7 +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.Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. +`Public Preview: please provide feedback `_: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. 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. diff --git a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt index cd0eae77c3..a3ade02a04 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt @@ -12,7 +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.Returns one cloud backup restore job for one cluster from the specified project. +`Public Preview: please provide feedback `_: Returns one cloud backup restore job for one cluster from the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt index 16b140bfaf..8be902e9e8 100644 --- a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt +++ b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt @@ -12,7 +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.Returns the cloud backup schedule for the specified cluster within the specified project. +`Public Preview: please provide feedback `_: Returns the cloud backup schedule for the specified cluster within the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt index a9d2822e85..6f1d82e306 100644 --- a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt @@ -12,7 +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.Returns the Backup Compliance Policy settings with the specified project. +`Public Preview: please provide feedback `_: Returns the Backup Compliance Policy settings with the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups-getExportBucket.txt b/docs/command/atlas-api-cloudBackups-getExportBucket.txt index 148b56e27c..9fd2c30d01 100644 --- a/docs/command/atlas-api-cloudBackups-getExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-getExportBucket.txt @@ -12,7 +12,7 @@ atlas api cloudBackups getExportBucket :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one Export Bucket associated with the specified Project.Returns one Export Bucket associated with the specified Project. +`Public Preview: please provide feedback `_: Returns one Export Bucket associated with the specified Project. 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. diff --git a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt index 259efed883..caa17ebde5 100644 --- a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt @@ -12,7 +12,7 @@ atlas api cloudBackups getReplicaSetBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one snapshot from the specified cluster.Returns one snapshot from the specified cluster. +`Public Preview: please provide feedback `_: Returns one snapshot from the specified cluster. 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. diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt index 37c57b649f..48bb89d7af 100644 --- a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt @@ -12,7 +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.Returns one snapshot of one serverless instance from the specified project. +`Public Preview: please provide feedback `_: Returns one snapshot of one serverless instance from the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt index 3a48e86dcc..5a5d017b35 100644 --- a/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt +++ b/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt @@ -12,7 +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.Returns one restore job for one serverless instance from the specified project. +`Public Preview: please provide feedback `_: Returns one restore job for one serverless instance from the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt index a0dca78e78..a8ed172bc9 100644 --- a/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt +++ b/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt @@ -12,7 +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.Returns one snapshot of one sharded cluster from the specified project. +`Public Preview: please provide feedback `_: Returns one snapshot of one sharded cluster from the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt index ce8bc11457..138b9f1742 100644 --- a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt @@ -12,7 +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.Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. +`Public Preview: please provide feedback `_: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. 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. diff --git a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt index 3a34e133c4..f09b3c3823 100644 --- a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt @@ -12,7 +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.Returns all cloud backup restore jobs for one cluster from the specified project. +`Public Preview: please provide feedback `_: Returns all cloud backup restore jobs for one cluster from the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt index fd4384a4d1..d79b8f6264 100644 --- a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt +++ b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt @@ -12,7 +12,7 @@ atlas api cloudBackups listExportBuckets :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all Export Buckets associated with the specified Project.Returns all Export Buckets associated with the specified Project. +`Public Preview: please provide feedback `_: Returns all Export Buckets associated with the specified Project. 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. diff --git a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt b/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt index a7b74362ac..5a1b8f4e00 100644 --- a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt @@ -12,7 +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.Returns all snapshots of one cluster from the specified project. +`Public Preview: please provide feedback `_: Returns all snapshots of one cluster from the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt index 67dbad2a23..75ca5e0de1 100644 --- a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt +++ b/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt @@ -12,7 +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.Returns all restore jobs for one serverless instance from the specified project. +`Public Preview: please provide feedback `_: Returns all restore jobs for one serverless instance from the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt index 1955f9a938..3ac3dcc38a 100644 --- a/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt @@ -12,7 +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.Returns all snapshots of one serverless instance from the specified project. +`Public Preview: please provide feedback `_: Returns all snapshots of one serverless instance from the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt b/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt index 4a8c834da4..82818e204f 100644 --- a/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt +++ b/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt @@ -12,7 +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.Returns all snapshots of one sharded cluster from the specified project. +`Public Preview: please provide feedback `_: Returns all snapshots of one sharded cluster from the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt b/docs/command/atlas-api-cloudBackups-takeSnapshot.txt index 96b2ff50ef..7d6f14f256 100644 --- a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt +++ b/docs/command/atlas-api-cloudBackups-takeSnapshot.txt @@ -12,7 +12,7 @@ atlas api cloudBackups takeSnapshot :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Takes one on-demand snapshot for the specified cluster.Takes one on-demand snapshot for the specified cluster. +`Public Preview: please provide feedback `_: Takes one on-demand snapshot for the specified cluster. 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. diff --git a/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt index a29c34e0ed..cfb47f9551 100644 --- a/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt +++ b/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt @@ -12,7 +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.Updates the cloud backup schedule for one cluster within the specified project. +`Public Preview: please provide feedback `_: Updates the cloud backup schedule for one cluster within the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt index 7dc0208ed4..c52b76132e 100644 --- a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt +++ b/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt @@ -12,7 +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.Updates the Backup Compliance Policy settings for the specified project. +`Public Preview: please provide feedback `_: Updates the Backup Compliance Policy settings for the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt b/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt index b455f718f5..a9c8413279 100644 --- a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt +++ b/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt @@ -12,7 +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.Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +`Public Preview: please provide feedback `_: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. 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. diff --git a/docs/command/atlas-api-cloudBackups.txt b/docs/command/atlas-api-cloudBackups.txt index 39a31a91ac..0af954f8fc 100644 --- a/docs/command/atlas-api-cloudBackups.txt +++ b/docs/command/atlas-api-cloudBackups.txt @@ -12,7 +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.Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. +`Public Preview: please provide feedback `_: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. 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. @@ -56,36 +56,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.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.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.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.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.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.Removes all cloud backup schedules for the specified cluster. -* :ref:`atlas-api-cloudBackups-deleteExportBucket` - `Public Preview: please provide feedback `_: Deletes an Export Bucket.Deletes an Export Bucket. -* :ref:`atlas-api-cloudBackups-deleteReplicaSetBackup` - `Public Preview: please provide feedback `_: Removes the specified snapshot.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt b/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt index ec16ea3d1c..1d4e610796 100644 --- a/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt +++ b/docs/command/atlas-api-cloudMigrationService-createLinkToken.txt @@ -12,7 +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.Create one link-token that contains all the information required to complete the link. +`Public Preview: please provide feedback `_: Create one link-token that contains all the information required to complete the link. 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. diff --git a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt index 54ec6ec610..0e7c37e2ce 100644 --- a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt @@ -12,7 +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.Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. +`Public Preview: please provide feedback `_: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. 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. diff --git a/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt b/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt index e5a08a096d..d5abf7aebe 100644 --- a/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt @@ -12,7 +12,7 @@ atlas api cloudMigrationService cutoverMigration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Cut over the migrated cluster to MongoDB Atlas.Cut over the migrated cluster to MongoDB Atlas. +`Public Preview: please provide feedback `_: Cut over the migrated cluster to MongoDB Atlas. 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. diff --git a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt b/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt index b188653666..ceac87edb9 100644 --- a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt +++ b/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt @@ -12,7 +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.Remove one organization link and its associated public API key. +`Public Preview: please provide feedback `_: Remove one organization link and its associated public API key. 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. diff --git a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt index b782dae7ee..29184178a9 100644 --- a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt @@ -12,7 +12,7 @@ atlas api cloudMigrationService getPushMigration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Return details of one cluster migration job.Return details of one cluster migration job. +`Public Preview: please provide feedback `_: Return details of one cluster migration job. 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. diff --git a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt b/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt index f95b21069a..75457b7ad9 100644 --- a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt +++ b/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt @@ -12,7 +12,7 @@ atlas api cloudMigrationService getValidationStatus :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Return the status of one migration validation job.Return the status of one migration validation job. +`Public Preview: please provide feedback `_: Return the status of one migration validation job. 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. diff --git a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt b/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt index 3753a7db9a..f69c4d97db 100644 --- a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt +++ b/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt @@ -12,7 +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.Return all projects that you can migrate to the specified organization. +`Public Preview: please provide feedback `_: Return all projects that you can migrate to the specified organization. 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. diff --git a/docs/command/atlas-api-cloudMigrationService-validateMigration.txt b/docs/command/atlas-api-cloudMigrationService-validateMigration.txt index 54228f2b15..a63fe9f1af 100644 --- a/docs/command/atlas-api-cloudMigrationService-validateMigration.txt +++ b/docs/command/atlas-api-cloudMigrationService-validateMigration.txt @@ -12,7 +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.Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. +`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. 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. diff --git a/docs/command/atlas-api-cloudMigrationService.txt b/docs/command/atlas-api-cloudMigrationService.txt index b2aa37423e..26af550033 100644 --- a/docs/command/atlas-api-cloudMigrationService.txt +++ b/docs/command/atlas-api-cloudMigrationService.txt @@ -12,7 +12,7 @@ atlas api cloudMigrationService :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Manages the Cloud Migration Service.Manages the Cloud Migration Service. +`Public Preview: please provide feedback `_: Manages the Cloud Migration Service. 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. @@ -56,14 +56,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.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.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.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.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.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.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.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.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` - `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. .. toctree:: diff --git a/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt index 9bc787c199..e0d268d6d2 100644 --- a/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt @@ -12,7 +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.Grants access to the specified project for the specified access role. +`Public Preview: please provide feedback `_: Grants access to the specified project for the specified access role. 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. diff --git a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt index b65b3e1587..996948a0ba 100644 --- a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt @@ -12,7 +12,7 @@ atlas api cloudProviderAccess createCloudProviderAccessRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one access role for the specified cloud provider.Creates one access role for the specified cloud provider. +`Public Preview: please provide feedback `_: Creates one access role for the specified cloud provider. 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. diff --git a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt index 9a773ccd9e..7b8442c2ac 100644 --- a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt @@ -12,7 +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.Revokes access to the specified project for the specified access role. +`Public Preview: please provide feedback `_: Revokes access to the specified project for the specified access role. 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. diff --git a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt index 8ca9b3aaf6..a051c44f28 100644 --- a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt +++ b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt @@ -12,7 +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.Returns the access role with the specified id and with access to the specified project. +`Public Preview: please provide feedback `_: Returns the access role with the specified id and with access to the specified project. 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. diff --git a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt index 248b4b0b5f..904e9da419 100644 --- a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt +++ b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt @@ -12,7 +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.Returns all cloud provider access roles with access to the specified project. +`Public Preview: please provide feedback `_: Returns all cloud provider access roles with access to the specified project. 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. diff --git a/docs/command/atlas-api-cloudProviderAccess.txt b/docs/command/atlas-api-cloudProviderAccess.txt index fb9ea534b7..6454c844c1 100644 --- a/docs/command/atlas-api-cloudProviderAccess.txt +++ b/docs/command/atlas-api-cloudProviderAccess.txt @@ -12,7 +12,7 @@ atlas api cloudProviderAccess :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas.Returns, adds, authorizes, and removes AWS IAM roles in Atlas. +`Public Preview: please provide feedback `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. 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. @@ -56,11 +56,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.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.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.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.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.Returns all cloud provider access roles with access to the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt index 9298a72e8d..501cb61eaa 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-endOutageSimulation.txt @@ -12,7 +12,7 @@ atlas api clusterOutageSimulation endOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Ends a cluster outage simulation.Ends a cluster outage simulation. +`Public Preview: please provide feedback `_: Ends a cluster outage simulation. 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. diff --git a/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt index eff0f4e162..d7603fc289 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-getOutageSimulation.txt @@ -12,7 +12,7 @@ atlas api clusterOutageSimulation getOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one outage simulation for one cluster.Returns one outage simulation for one cluster. +`Public Preview: please provide feedback `_: Returns one outage simulation for one cluster. 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. diff --git a/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt index feec5beaa5..63e8d9075b 100644 --- a/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt @@ -12,7 +12,7 @@ atlas api clusterOutageSimulation startOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Starts a cluster outage simulation.Starts a cluster outage simulation. +`Public Preview: please provide feedback `_: Starts a cluster outage simulation. 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. diff --git a/docs/command/atlas-api-clusterOutageSimulation.txt b/docs/command/atlas-api-clusterOutageSimulation.txt index d3b8828647..c189351ae6 100644 --- a/docs/command/atlas-api-clusterOutageSimulation.txt +++ b/docs/command/atlas-api-clusterOutageSimulation.txt @@ -12,7 +12,7 @@ atlas api clusterOutageSimulation :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, starts, or ends a cluster outage simulation.Returns, starts, or ends a cluster outage simulation. +`Public Preview: please provide feedback `_: Returns, starts, or ends a cluster outage simulation. 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. @@ -56,9 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-clusterOutageSimulation-endOutageSimulation` - `Public Preview: please provide feedback `_: Ends a cluster outage simulation.Ends a cluster outage simulation. -* :ref:`atlas-api-clusterOutageSimulation-getOutageSimulation` - `Public Preview: please provide feedback `_: Returns one outage simulation for one cluster.Returns one outage simulation for one cluster. -* :ref:`atlas-api-clusterOutageSimulation-startOutageSimulation` - `Public Preview: please provide feedback `_: Starts a cluster outage simulation.Starts a cluster outage simulation. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-clusters-autoScalingConfiguration.txt b/docs/command/atlas-api-clusters-autoScalingConfiguration.txt index bbb07bc404..d4db0fce67 100644 --- a/docs/command/atlas-api-clusters-autoScalingConfiguration.txt +++ b/docs/command/atlas-api-clusters-autoScalingConfiguration.txt @@ -12,7 +12,7 @@ atlas api clusters autoScalingConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the internal configuration of AutoScaling for sharded clusters.Returns the internal configuration of AutoScaling for sharded clusters. +`Public Preview: please provide feedback `_: Returns the internal configuration of AutoScaling for sharded clusters. 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. diff --git a/docs/command/atlas-api-clusters-createCluster.txt b/docs/command/atlas-api-clusters-createCluster.txt index 1f444905b7..113702e8b9 100644 --- a/docs/command/atlas-api-clusters-createCluster.txt +++ b/docs/command/atlas-api-clusters-createCluster.txt @@ -12,7 +12,7 @@ atlas api clusters createCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one cluster in the specified project.Creates one cluster in the specified project. +`Public Preview: please provide feedback `_: Creates one cluster in the specified project. 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. diff --git a/docs/command/atlas-api-clusters-deleteCluster.txt b/docs/command/atlas-api-clusters-deleteCluster.txt index 3b5f1b79fb..3aa744f336 100644 --- a/docs/command/atlas-api-clusters-deleteCluster.txt +++ b/docs/command/atlas-api-clusters-deleteCluster.txt @@ -12,7 +12,7 @@ atlas api clusters deleteCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one cluster from the specified project.Removes one cluster from the specified project. +`Public Preview: please provide feedback `_: Removes one cluster from the specified project. 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. diff --git a/docs/command/atlas-api-clusters-getCluster.txt b/docs/command/atlas-api-clusters-getCluster.txt index 3c94cd8c8a..58961961e8 100644 --- a/docs/command/atlas-api-clusters-getCluster.txt +++ b/docs/command/atlas-api-clusters-getCluster.txt @@ -12,7 +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.Returns the details for one cluster in the specified project. +`Public Preview: please provide feedback `_: Returns the details for one cluster in the specified project. 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. diff --git a/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt index 7cbc372362..fced8f154b 100644 --- a/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt +++ b/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt @@ -12,7 +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.Returns the advanced configuration details for one cluster in the specified project. +`Public Preview: please provide feedback `_: Returns the advanced configuration details for one cluster in the specified project. 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. diff --git a/docs/command/atlas-api-clusters-getClusterStatus.txt b/docs/command/atlas-api-clusters-getClusterStatus.txt index 16c95bad13..f6c7880bab 100644 --- a/docs/command/atlas-api-clusters-getClusterStatus.txt +++ b/docs/command/atlas-api-clusters-getClusterStatus.txt @@ -12,7 +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.Returns the status of all changes that you made to the specified cluster in the specified project. +`Public Preview: please provide feedback `_: Returns the status of all changes that you made to the specified cluster in the specified project. 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. diff --git a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt b/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt index b9c5fb2f85..ba2b5110f1 100644 --- a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt +++ b/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt @@ -12,7 +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.Checks the progress of loading the sample dataset into one cluster. +`Public Preview: please provide feedback `_: Checks the progress of loading the sample dataset into one cluster. 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. diff --git a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt index 4d7be2decb..272e16978b 100644 --- a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt +++ b/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt @@ -12,7 +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.Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. +`Public Preview: please provide feedback `_: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. 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. diff --git a/docs/command/atlas-api-clusters-listCloudProviderRegions.txt b/docs/command/atlas-api-clusters-listCloudProviderRegions.txt index fbd8aed290..02ef17e1a1 100644 --- a/docs/command/atlas-api-clusters-listCloudProviderRegions.txt +++ b/docs/command/atlas-api-clusters-listCloudProviderRegions.txt @@ -12,7 +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.Returns the list of regions available for the specified cloud provider at the specified tier. +`Public Preview: please provide feedback `_: Returns the list of regions available for the specified cloud provider at the specified tier. 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. diff --git a/docs/command/atlas-api-clusters-listClusters.txt b/docs/command/atlas-api-clusters-listClusters.txt index 236b458891..a61f2ef3a4 100644 --- a/docs/command/atlas-api-clusters-listClusters.txt +++ b/docs/command/atlas-api-clusters-listClusters.txt @@ -12,7 +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.Returns the details for all clusters in the specific project to which you have access. +`Public Preview: please provide feedback `_: Returns the details for all clusters in the specific project to which you have 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. diff --git a/docs/command/atlas-api-clusters-listClustersForAllProjects.txt b/docs/command/atlas-api-clusters-listClustersForAllProjects.txt index 4a9a4611b9..5be6346b82 100644 --- a/docs/command/atlas-api-clusters-listClustersForAllProjects.txt +++ b/docs/command/atlas-api-clusters-listClustersForAllProjects.txt @@ -12,7 +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.Returns the details for all clusters in all projects to which you have access. +`Public Preview: please provide feedback `_: Returns the details for all clusters in all projects to which you have 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. diff --git a/docs/command/atlas-api-clusters-loadSampleDataset.txt b/docs/command/atlas-api-clusters-loadSampleDataset.txt index 496825dfef..684cf0fe79 100644 --- a/docs/command/atlas-api-clusters-loadSampleDataset.txt +++ b/docs/command/atlas-api-clusters-loadSampleDataset.txt @@ -12,7 +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.Requests loading the MongoDB sample dataset into the specified cluster. +`Public Preview: please provide feedback `_: Requests loading the MongoDB sample dataset into the specified cluster. 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. diff --git a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt index 3b921efef5..df030e9dd7 100644 --- a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt +++ b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt @@ -12,7 +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.Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. +`Public Preview: please provide feedback `_: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. 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. diff --git a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt index 39f5a66e69..80d1b4b781 100644 --- a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt +++ b/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt @@ -12,7 +12,7 @@ atlas api clusters revokeMongoDbEmployeeAccess :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Revokes a previously granted MongoDB employee cluster access.Revokes a previously granted MongoDB employee cluster access. +`Public Preview: please provide feedback `_: Revokes a previously granted MongoDB employee cluster 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. diff --git a/docs/command/atlas-api-clusters-testFailover.txt b/docs/command/atlas-api-clusters-testFailover.txt index 79210eb925..671033d5b8 100644 --- a/docs/command/atlas-api-clusters-testFailover.txt +++ b/docs/command/atlas-api-clusters-testFailover.txt @@ -12,7 +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.Starts a failover test for the specified cluster in the specified project. +`Public Preview: please provide feedback `_: Starts a failover test for the specified cluster in the specified project. 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. diff --git a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt index 1e9bc88957..1423fa6145 100644 --- a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt +++ b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt @@ -12,7 +12,7 @@ atlas api clusters unpinFeatureCompatibilityVersion :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Unpins the current fixed Feature Compatibility Version (FCV).Unpins the current fixed Feature Compatibility Version (FCV). +`Public Preview: please provide feedback `_: Unpins the current fixed Feature Compatibility Version (FCV). 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. diff --git a/docs/command/atlas-api-clusters-updateCluster.txt b/docs/command/atlas-api-clusters-updateCluster.txt index 4d4978ee27..2513a740dd 100644 --- a/docs/command/atlas-api-clusters-updateCluster.txt +++ b/docs/command/atlas-api-clusters-updateCluster.txt @@ -12,7 +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.Updates the details for one cluster in the specified project. +`Public Preview: please provide feedback `_: Updates the details for one cluster in the specified project. 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. diff --git a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt index cc292bdb8b..52458c9391 100644 --- a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt +++ b/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt @@ -12,7 +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.Updates the advanced configuration details for one cluster in the specified project. +`Public Preview: please provide feedback `_: Updates the advanced configuration details for one cluster in the specified project. 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. diff --git a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt b/docs/command/atlas-api-clusters-upgradeSharedCluster.txt index df04f7fa5f..3135b27d9c 100644 --- a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt +++ b/docs/command/atlas-api-clusters-upgradeSharedCluster.txt @@ -12,7 +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.Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. +`Public Preview: please provide feedback `_: Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. 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. diff --git a/docs/command/atlas-api-clusters.txt b/docs/command/atlas-api-clusters.txt index b185bbf340..fe4ff5137f 100644 --- a/docs/command/atlas-api-clusters.txt +++ b/docs/command/atlas-api-clusters.txt @@ -12,7 +12,7 @@ atlas api clusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes database deployments.Returns, adds, edits, and removes database deployments. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes database deployments. 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. @@ -56,25 +56,25 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-clusters-autoScalingConfiguration` - `Public Preview: please provide feedback `_: Returns the internal configuration of AutoScaling for sharded clusters.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.Creates one cluster in the specified project. -* :ref:`atlas-api-clusters-deleteCluster` - `Public Preview: please provide feedback `_: Removes one cluster from the specified project.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.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.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.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.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.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.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.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.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.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.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.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.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).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.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.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.Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt index 91d4a8c4c0..01e6a8aa9f 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt @@ -12,7 +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.Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. +`Public Preview: please provide feedback `_: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. 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. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt index 390e689afd..5390d030d7 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements.txt @@ -12,7 +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.Get a list of the Coll Stats Latency process-level measurements for the given namespace. +`Public Preview: please provide feedback `_: Get a list of the Coll Stats Latency process-level measurements for the given namespace. 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. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt index 370bad5d85..22a88d3d85 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt @@ -12,7 +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.Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. +`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. 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. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt index 6fd736f44c..e5de6a7856 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster.txt @@ -12,7 +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.Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. +`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. 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. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt index 0f14babad4..961c57f3d2 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost.txt @@ -12,7 +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.Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. +`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. 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. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt index 2a217d97e4..942648ee68 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-getPinnedNamespaces.txt @@ -12,7 +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.Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. +`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. 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. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt index c7f0594538..65542d0ff5 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt @@ -12,7 +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.Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. +`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. 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. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt index b3fcde1ec2..3da6a1d762 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt @@ -12,7 +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.Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +`Public Preview: please provide feedback `_: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. 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. diff --git a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt index 50b17039f2..35988e455c 100644 --- a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt +++ b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt @@ -12,7 +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.Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +`Public Preview: please provide feedback `_: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. 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. diff --git a/docs/command/atlas-api-collectionLevelMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics.txt index 4ef0c611bb..742e9e2497 100644 --- a/docs/command/atlas-api-collectionLevelMetrics.txt +++ b/docs/command/atlas-api-collectionLevelMetrics.txt @@ -12,7 +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.Returns, adds, and edits pinned namespaces for the specified cluster or process. +`Public Preview: please provide feedback `_: Returns, adds, and edits pinned namespaces for the specified cluster or process. 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. @@ -56,15 +56,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.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.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.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.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.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.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.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.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.Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt index aceb1e0368..04532b759f 100644 --- a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt @@ -12,7 +12,7 @@ atlas api customDatabaseRoles createCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one custom role in the specified project.Creates one custom role in the specified project. +`Public Preview: please provide feedback `_: Creates one custom role in the specified project. 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. diff --git a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt index 248f77a3de..7ca62893aa 100644 --- a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt @@ -12,7 +12,7 @@ atlas api customDatabaseRoles deleteCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one custom role from the specified project.Removes one custom role from the specified project. +`Public Preview: please provide feedback `_: Removes one custom role from the specified project. 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. diff --git a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt index 343e291df7..c6d675d585 100644 --- a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt @@ -12,7 +12,7 @@ atlas api customDatabaseRoles getCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one custom role for the specified project.Returns one custom role for the specified project. +`Public Preview: please provide feedback `_: Returns one custom role for the specified project. 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. diff --git a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt index 1c635389e2..10688a8ab9 100644 --- a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt +++ b/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt @@ -12,7 +12,7 @@ atlas api customDatabaseRoles listCustomDatabaseRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all custom roles for the specified project.Returns all custom roles for the specified project. +`Public Preview: please provide feedback `_: Returns all custom roles for the specified project. 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. diff --git a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt index 1e6a1a1420..e567208efc 100644 --- a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt +++ b/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt @@ -12,7 +12,7 @@ atlas api customDatabaseRoles updateCustomDatabaseRole :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one custom role in the specified project.Updates one custom role in the specified project. +`Public Preview: please provide feedback `_: Updates one custom role in the specified project. 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. diff --git a/docs/command/atlas-api-customDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles.txt index bb1d33f50e..1e366e97b9 100644 --- a/docs/command/atlas-api-customDatabaseRoles.txt +++ b/docs/command/atlas-api-customDatabaseRoles.txt @@ -12,7 +12,7 @@ atlas api customDatabaseRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes custom database user privilege roles.Returns, adds, edits, and removes custom database user privilege roles. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes custom database user privilege roles. 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. @@ -56,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-customDatabaseRoles-createCustomDatabaseRole` - `Public Preview: please provide feedback `_: Creates one custom role in the specified project.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.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.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.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.Updates one custom role in the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt index 103c461fd5..8c994d59c8 100644 --- a/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt @@ -12,7 +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.Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. +`Public Preview: please provide feedback `_: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. 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. diff --git a/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt index 3d1fde0e50..28c469ee62 100644 --- a/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt @@ -12,7 +12,7 @@ atlas api dataFederation createFederatedDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one federated database instance in the specified project.Creates one federated database instance in the specified project. +`Public Preview: please provide feedback `_: Creates one federated database instance in the specified project. 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. diff --git a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt b/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt index a3ade74df3..f30f235caf 100644 --- a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt @@ -12,7 +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.Creates or updates one query limit for one federated database instance. +`Public Preview: please provide feedback `_: Creates or updates one query limit for one federated database instance. 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. diff --git a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt index 5dc8c637f2..d5ba23fb36 100644 --- a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt @@ -12,7 +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.Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. +`Public Preview: please provide feedback `_: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. 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. diff --git a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt index ccbbdd432f..9d2e90efc7 100644 --- a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt @@ -12,7 +12,7 @@ atlas api dataFederation deleteFederatedDatabase :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one federated database instance from the specified project.Removes one federated database instance from the specified project. +`Public Preview: please provide feedback `_: Removes one federated database instance from the specified project. 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. diff --git a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt b/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt index 482518e697..149fc7d47d 100644 --- a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt @@ -12,7 +12,7 @@ atlas api dataFederation deleteOneDataFederationInstanceQueryLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes one query limit for one federated database instance.Deletes one query limit for one federated database instance. +`Public Preview: please provide feedback `_: Deletes one query limit for one federated database instance. 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. diff --git a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt b/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt index 5d54879c36..44ec3de6ae 100644 --- a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt +++ b/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt @@ -12,7 +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.Downloads the query logs for the specified federated database instance. +`Public Preview: please provide feedback `_: Downloads the query logs for the specified federated database instance. 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. diff --git a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt index fdf5766498..8ffb85b0ad 100644 --- a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt +++ b/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt @@ -12,7 +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.Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. +`Public Preview: please provide feedback `_: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. 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. diff --git a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt index c88431edb8..5c8c20149e 100644 --- a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt @@ -12,7 +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.Returns the details of one federated database instance within the specified project. +`Public Preview: please provide feedback `_: Returns the details of one federated database instance within the specified project. 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. diff --git a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt b/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt index ca32009c2e..fe694fd449 100644 --- a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt +++ b/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt @@ -12,7 +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.Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. +`Public Preview: please provide feedback `_: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. 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. diff --git a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt b/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt index 2a81f40e75..cd15520fc3 100644 --- a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt +++ b/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt @@ -12,7 +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.Returns the details of all federated database instances in the specified project. +`Public Preview: please provide feedback `_: Returns the details of all federated database instances in the specified project. 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. diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt index e56216a806..d4e0f217ae 100644 --- a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt +++ b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt @@ -12,7 +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.Returns the details of one query limit for the specified federated database instance in the specified project. +`Public Preview: please provide feedback `_: Returns the details of one query limit for the specified federated database instance in the specified project. 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. diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt index 6c663fa42c..b215dfb5d8 100644 --- a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt +++ b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt @@ -12,7 +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.Returns query limits for a federated databases instance in the specified project. +`Public Preview: please provide feedback `_: Returns query limits for a federated databases instance in the specified project. 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. diff --git a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt index e3cd4e4e9e..baa2fc5663 100644 --- a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt +++ b/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt @@ -12,7 +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.Updates the details of one federated database instance in the specified project. +`Public Preview: please provide feedback `_: Updates the details of one federated database instance in the specified project. 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. diff --git a/docs/command/atlas-api-dataFederation.txt b/docs/command/atlas-api-dataFederation.txt index 0780a5e25c..9c3ef77362 100644 --- a/docs/command/atlas-api-dataFederation.txt +++ b/docs/command/atlas-api-dataFederation.txt @@ -12,7 +12,7 @@ atlas api dataFederation :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes Federated Database Instances.Returns, adds, edits, and removes Federated Database Instances. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes Federated Database Instances. 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. @@ -56,20 +56,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.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.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.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.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.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.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.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.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.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.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.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.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.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.Updates the details of one federated database instance in the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-dataLakePipelines-createPipeline.txt b/docs/command/atlas-api-dataLakePipelines-createPipeline.txt index 16500b8ace..156fa43b79 100644 --- a/docs/command/atlas-api-dataLakePipelines-createPipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-createPipeline.txt @@ -12,7 +12,7 @@ atlas api dataLakePipelines createPipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one Data Lake Pipeline.Creates one Data Lake Pipeline. +`Public Preview: please provide feedback `_: Creates one Data Lake Pipeline. 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. diff --git a/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt b/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt index 3b5885e7fa..5857f87f6c 100644 --- a/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-deletePipeline.txt @@ -12,7 +12,7 @@ atlas api dataLakePipelines deletePipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one Data Lake Pipeline.Removes one Data Lake Pipeline. +`Public Preview: please provide feedback `_: Removes one Data Lake Pipeline. 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. diff --git a/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt b/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt index d1763f568f..cddd27953c 100644 --- a/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt +++ b/docs/command/atlas-api-dataLakePipelines-deletePipelineRunDataset.txt @@ -12,7 +12,7 @@ atlas api dataLakePipelines deletePipelineRunDataset :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes dataset that Atlas generated during the specified pipeline run.Deletes dataset that Atlas generated during the specified pipeline run. +`Public Preview: please provide feedback `_: Deletes dataset that Atlas generated during the specified pipeline run. 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. diff --git a/docs/command/atlas-api-dataLakePipelines-getPipeline.txt b/docs/command/atlas-api-dataLakePipelines-getPipeline.txt index 2baef106d9..0ecbbef181 100644 --- a/docs/command/atlas-api-dataLakePipelines-getPipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-getPipeline.txt @@ -12,7 +12,7 @@ atlas api dataLakePipelines getPipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the details of one Data Lake Pipeline within the specified project.Returns the details of one Data Lake Pipeline within the specified project. +`Public Preview: please provide feedback `_: Returns the details of one Data Lake Pipeline within the specified project. 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. diff --git a/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt b/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt index 4175adf223..38b9d6a858 100644 --- a/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt +++ b/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt @@ -12,7 +12,7 @@ atlas api dataLakePipelines getPipelineRun :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the details of one Data Lake Pipeline run within the specified project.Returns the details of one Data Lake Pipeline run within the specified project. +`Public Preview: please provide feedback `_: Returns the details of one Data Lake Pipeline run within the specified project. 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. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt index bbec3bbc76..0891dd888b 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt @@ -12,7 +12,7 @@ atlas api dataLakePipelines listPipelineRuns :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns a list of past Data Lake Pipeline runs.Returns a list of past Data Lake Pipeline runs. +`Public Preview: please provide feedback `_: Returns a list of past Data Lake Pipeline runs. 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. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt index bf9424520f..a7cfa52f77 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt @@ -12,7 +12,7 @@ atlas api dataLakePipelines listPipelineSchedules :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source.Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. +`Public Preview: please provide feedback `_: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. 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. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt index dd6aaaf6aa..d3639acad8 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt @@ -12,7 +12,7 @@ atlas api dataLakePipelines listPipelineSnapshots :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run.Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. +`Public Preview: please provide feedback `_: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. 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. diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelines.txt b/docs/command/atlas-api-dataLakePipelines-listPipelines.txt index 159c1ba677..8eb6937193 100644 --- a/docs/command/atlas-api-dataLakePipelines-listPipelines.txt +++ b/docs/command/atlas-api-dataLakePipelines-listPipelines.txt @@ -12,7 +12,7 @@ atlas api dataLakePipelines listPipelines :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns a list of Data Lake Pipelines.Returns a list of Data Lake Pipelines. +`Public Preview: please provide feedback `_: Returns a list of Data Lake Pipelines. 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. diff --git a/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt b/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt index 2051817950..a8b9c41b3f 100644 --- a/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt @@ -12,7 +12,7 @@ atlas api dataLakePipelines pausePipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Pauses ingestion for a Data Lake Pipeline within the specified project.Pauses ingestion for a Data Lake Pipeline within the specified project. +`Public Preview: please provide feedback `_: Pauses ingestion for a Data Lake Pipeline within the specified project. 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. diff --git a/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt b/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt index e288100b4e..104c23717b 100644 --- a/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt @@ -12,7 +12,7 @@ atlas api dataLakePipelines resumePipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Resumes ingestion for a Data Lake Pipeline within the specified project.Resumes ingestion for a Data Lake Pipeline within the specified project. +`Public Preview: please provide feedback `_: Resumes ingestion for a Data Lake Pipeline within the specified project. 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. diff --git a/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt b/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt index a1844c8e00..80c7152fa5 100644 --- a/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt +++ b/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt @@ -12,7 +12,7 @@ atlas api dataLakePipelines triggerSnapshotIngestion :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Triggers a Data Lake Pipeline ingestion of a specified snapshot.Triggers a Data Lake Pipeline ingestion of a specified snapshot. +`Public Preview: please provide feedback `_: Triggers a Data Lake Pipeline ingestion of a specified snapshot. 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. diff --git a/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt b/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt index 4e250517b7..5519bc5b23 100644 --- a/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt +++ b/docs/command/atlas-api-dataLakePipelines-updatePipeline.txt @@ -12,7 +12,7 @@ atlas api dataLakePipelines updatePipeline :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one Data Lake Pipeline.Updates one Data Lake Pipeline. +`Public Preview: please provide feedback `_: Updates one Data Lake Pipeline. 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. diff --git a/docs/command/atlas-api-dataLakePipelines.txt b/docs/command/atlas-api-dataLakePipelines.txt index a34e92f9c0..1c79ff1023 100644 --- a/docs/command/atlas-api-dataLakePipelines.txt +++ b/docs/command/atlas-api-dataLakePipelines.txt @@ -12,7 +12,7 @@ atlas api dataLakePipelines :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs.Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. +`Public Preview: please provide feedback `_: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. 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. @@ -56,19 +56,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-dataLakePipelines-createPipeline` - `Public Preview: please provide feedback `_: Creates one Data Lake Pipeline.Creates one Data Lake Pipeline. -* :ref:`atlas-api-dataLakePipelines-deletePipeline` - `Public Preview: please provide feedback `_: Removes one Data Lake Pipeline.Removes one Data Lake Pipeline. -* :ref:`atlas-api-dataLakePipelines-deletePipelineRunDataset` - `Public Preview: please provide feedback `_: Deletes dataset that Atlas generated during the specified pipeline run.Deletes dataset that Atlas generated during the specified pipeline run. -* :ref:`atlas-api-dataLakePipelines-getPipeline` - `Public Preview: please provide feedback `_: Returns the details of one Data Lake Pipeline within the specified project.Returns the details of one Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-getPipelineRun` - `Public Preview: please provide feedback `_: Returns the details of one Data Lake Pipeline run within the specified project.Returns the details of one Data Lake Pipeline run within the specified project. -* :ref:`atlas-api-dataLakePipelines-listPipelineRuns` - `Public Preview: please provide feedback `_: Returns a list of past Data Lake Pipeline runs.Returns a list of past Data Lake Pipeline runs. -* :ref:`atlas-api-dataLakePipelines-listPipelineSchedules` - `Public Preview: please provide feedback `_: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source.Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. -* :ref:`atlas-api-dataLakePipelines-listPipelineSnapshots` - `Public Preview: please provide feedback `_: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run.Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. -* :ref:`atlas-api-dataLakePipelines-listPipelines` - `Public Preview: please provide feedback `_: Returns a list of Data Lake Pipelines.Returns a list of Data Lake Pipelines. -* :ref:`atlas-api-dataLakePipelines-pausePipeline` - `Public Preview: please provide feedback `_: Pauses ingestion for a Data Lake Pipeline within the specified project.Pauses ingestion for a Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-resumePipeline` - `Public Preview: please provide feedback `_: Resumes ingestion for a Data Lake Pipeline within the specified project.Resumes ingestion for a Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-triggerSnapshotIngestion` - `Public Preview: please provide feedback `_: Triggers a Data Lake Pipeline ingestion of a specified snapshot.Triggers a Data Lake Pipeline ingestion of a specified snapshot. -* :ref:`atlas-api-dataLakePipelines-updatePipeline` - `Public Preview: please provide feedback `_: Updates one Data Lake Pipeline.Updates one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-createPipeline` - `Public Preview: please provide feedback `_: Creates one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-deletePipeline` - `Public Preview: please provide feedback `_: Removes one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-deletePipelineRunDataset` - `Public Preview: please provide feedback `_: Deletes dataset that Atlas generated during the specified pipeline run. +* :ref:`atlas-api-dataLakePipelines-getPipeline` - `Public Preview: please provide feedback `_: Returns the details of one Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-getPipelineRun` - `Public Preview: please provide feedback `_: Returns the details of one Data Lake Pipeline run within the specified project. +* :ref:`atlas-api-dataLakePipelines-listPipelineRuns` - `Public Preview: please provide feedback `_: Returns a list of past Data Lake Pipeline runs. +* :ref:`atlas-api-dataLakePipelines-listPipelineSchedules` - `Public Preview: please provide feedback `_: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. +* :ref:`atlas-api-dataLakePipelines-listPipelineSnapshots` - `Public Preview: please provide feedback `_: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. +* :ref:`atlas-api-dataLakePipelines-listPipelines` - `Public Preview: please provide feedback `_: Returns a list of Data Lake Pipelines. +* :ref:`atlas-api-dataLakePipelines-pausePipeline` - `Public Preview: please provide feedback `_: Pauses ingestion for a Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-resumePipeline` - `Public Preview: please provide feedback `_: Resumes ingestion for a Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-triggerSnapshotIngestion` - `Public Preview: please provide feedback `_: Triggers a Data Lake Pipeline ingestion of a specified snapshot. +* :ref:`atlas-api-dataLakePipelines-updatePipeline` - `Public Preview: please provide feedback `_: Updates one Data Lake Pipeline. .. toctree:: diff --git a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt index d6c59a504f..8aa2d47ce6 100644 --- a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt @@ -12,7 +12,7 @@ atlas api databaseUsers createDatabaseUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one database user in the specified project.Creates one database user in the specified project. +`Public Preview: please provide feedback `_: Creates one database user in the specified project. 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. diff --git a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt index b9b08cf47e..ef6511c3ae 100644 --- a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt @@ -12,7 +12,7 @@ atlas api databaseUsers deleteDatabaseUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one database user from the specified project.Removes one database user from the specified project. +`Public Preview: please provide feedback `_: Removes one database user from the specified project. 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. diff --git a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt index ad1a1d13a1..031d4bb007 100644 --- a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt @@ -12,7 +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.Returns one database user that belong to the specified project. +`Public Preview: please provide feedback `_: Returns one database user that belong to the specified project. 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. diff --git a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt index 7368040def..9085da2957 100644 --- a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt +++ b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt @@ -12,7 +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.Returns all database users that belong to the specified project. +`Public Preview: please provide feedback `_: Returns all database users that belong to the specified project. 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. diff --git a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt index 3916feda89..06b5df3c5c 100644 --- a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt @@ -12,7 +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.Updates one database user that belongs to the specified project. +`Public Preview: please provide feedback `_: Updates one database user that belongs to the specified project. 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. diff --git a/docs/command/atlas-api-databaseUsers.txt b/docs/command/atlas-api-databaseUsers.txt index e8db626976..8b6f4986b2 100644 --- a/docs/command/atlas-api-databaseUsers.txt +++ b/docs/command/atlas-api-databaseUsers.txt @@ -12,7 +12,7 @@ atlas api databaseUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes database users.Returns, adds, edits, and removes database users. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes database users. 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. @@ -56,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-databaseUsers-createDatabaseUser` - `Public Preview: please provide feedback `_: Creates one database user in the specified project.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.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.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.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.Updates one database user that belongs to the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt index 43b949d21a..96c11f60ff 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint.txt @@ -12,7 +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.Creates a private endpoint in the specified region for encryption at rest using customer key management. +`Public Preview: please provide feedback `_: Creates a private endpoint in the specified region for encryption at rest using customer key management. 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. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt index 4c8d6373c7..e39d2e6563 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest.txt @@ -12,7 +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.Returns the configuration for encryption at rest using the keys you manage through your cloud provider. +`Public Preview: please provide feedback `_: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. 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. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt index f8a3b60ba4..99842e0cb8 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt @@ -12,7 +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.Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +`Public Preview: please provide feedback `_: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. 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. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt index 855a98d4cb..144fd4f259 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider.txt @@ -12,7 +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.Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. +`Public Preview: please provide feedback `_: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. 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. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt index 7448ec2f6a..f6e8627005 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion.txt @@ -12,7 +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.Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +`Public Preview: please provide feedback `_: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. 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. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt index 0706b37a7c..b23f0f2e45 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest.txt @@ -12,7 +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.Updates the configuration for encryption at rest using the keys you manage through your cloud provider. +`Public Preview: please provide feedback `_: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. 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. diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt index d9398707b6..13e519603d 100644 --- a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt +++ b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt @@ -12,7 +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.Returns and edits the Encryption at Rest using Customer Key Management configuration. +`Public Preview: please provide feedback `_: Returns and edits the Encryption at Rest using Customer Key Management configuration. 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. @@ -56,12 +56,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.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.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.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.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.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.Updates the configuration for encryption at rest using the keys you manage through your cloud provider. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-events-getOrganizationEvent.txt b/docs/command/atlas-api-events-getOrganizationEvent.txt index 0f47c9d8ad..2e2390af61 100644 --- a/docs/command/atlas-api-events-getOrganizationEvent.txt +++ b/docs/command/atlas-api-events-getOrganizationEvent.txt @@ -12,7 +12,7 @@ atlas api events getOrganizationEvent :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one event for the specified organization.Returns one event for the specified organization. +`Public Preview: please provide feedback `_: Returns one event for the specified organization. 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. diff --git a/docs/command/atlas-api-events-getProjectEvent.txt b/docs/command/atlas-api-events-getProjectEvent.txt index 5f4af219ec..6651549648 100644 --- a/docs/command/atlas-api-events-getProjectEvent.txt +++ b/docs/command/atlas-api-events-getProjectEvent.txt @@ -12,7 +12,7 @@ atlas api events getProjectEvent :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one event for the specified project.Returns one event for the specified project. +`Public Preview: please provide feedback `_: Returns one event for the specified project. 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. diff --git a/docs/command/atlas-api-events-listEventTypes.txt b/docs/command/atlas-api-events-listEventTypes.txt index b56230885f..595372c8ef 100644 --- a/docs/command/atlas-api-events-listEventTypes.txt +++ b/docs/command/atlas-api-events-listEventTypes.txt @@ -12,7 +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.Returns a list of all event types, along with a description and additional metadata about each event. +`Public Preview: please provide feedback `_: Returns a list of all event types, along with a description and additional metadata about each event. 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. diff --git a/docs/command/atlas-api-events-listOrganizationEvents.txt b/docs/command/atlas-api-events-listOrganizationEvents.txt index e86e542a6d..5c44c570b1 100644 --- a/docs/command/atlas-api-events-listOrganizationEvents.txt +++ b/docs/command/atlas-api-events-listOrganizationEvents.txt @@ -12,7 +12,7 @@ atlas api events listOrganizationEvents :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all events for the specified organization.Returns all events for the specified organization. +`Public Preview: please provide feedback `_: Returns all events for the specified organization. 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. diff --git a/docs/command/atlas-api-events-listProjectEvents.txt b/docs/command/atlas-api-events-listProjectEvents.txt index e74a394ae2..df9efac288 100644 --- a/docs/command/atlas-api-events-listProjectEvents.txt +++ b/docs/command/atlas-api-events-listProjectEvents.txt @@ -12,7 +12,7 @@ atlas api events listProjectEvents :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all events for the specified project.Returns all events for the specified project. +`Public Preview: please provide feedback `_: Returns all events for the specified project. 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. diff --git a/docs/command/atlas-api-events.txt b/docs/command/atlas-api-events.txt index a6c65eb74c..20eb7fa2f8 100644 --- a/docs/command/atlas-api-events.txt +++ b/docs/command/atlas-api-events.txt @@ -12,7 +12,7 @@ atlas api events :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns events.Returns events. +`Public Preview: please provide feedback `_: Returns events. 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. @@ -56,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-events-getOrganizationEvent` - `Public Preview: please provide feedback `_: Returns one event for the specified organization.Returns one event for the specified organization. -* :ref:`atlas-api-events-getProjectEvent` - `Public Preview: please provide feedback `_: Returns one event for the specified project.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.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 all events for the specified organization.Returns all events for the specified organization. -* :ref:`atlas-api-events-listProjectEvents` - `Public Preview: please provide feedback `_: Returns all events for the specified project.Returns all events for the specified project. +* :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 all events for the specified organization. +* :ref:`atlas-api-events-listProjectEvents` - `Public Preview: please provide feedback `_: Returns all 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 998878d6ae..d96edc07e8 100644 --- a/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-createIdentityProvider.txt @@ -12,7 +12,7 @@ atlas api federatedAuthentication createIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one identity provider within the specified federation.Creates one identity provider within the specified federation. +`Public Preview: please provide feedback `_: Creates one identity provider within the specified federation. 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. diff --git a/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt index 892c2db955..0413ffe3bb 100644 --- a/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt @@ -12,7 +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.Adds one role mapping to the specified organization in the specified federation. +`Public Preview: please provide feedback `_: Adds one role mapping to the specified organization in the specified federation. 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. diff --git a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt b/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt index 9220eb8b6f..bae51741d2 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt @@ -12,7 +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.Deletes the federation settings instance and all associated data, including identity providers and domains. +`Public Preview: please provide feedback `_: Deletes the federation settings instance and all associated data, including identity providers and domains. 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. diff --git a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt index b49bce075d..03f1637fba 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt @@ -12,7 +12,7 @@ atlas api federatedAuthentication deleteIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes one identity provider in the specified federation.Deletes one identity provider in the specified federation. +`Public Preview: please provide feedback `_: Deletes one identity provider in the specified federation. 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. diff --git a/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt index e7be1a1df1..758e600cb8 100644 --- a/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt @@ -12,7 +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.Removes one role mapping in the specified organization from the specified federation. +`Public Preview: please provide feedback `_: Removes one role mapping in the specified organization from the specified federation. 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. diff --git a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt index e13f72d701..346f82f711 100644 --- a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt @@ -12,7 +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.Returns the specified connected org config from the specified federation. +`Public Preview: please provide feedback `_: Returns the specified connected org config from the specified federation. 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. diff --git a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt index 259eaba023..b864992b3b 100644 --- a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt +++ b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt @@ -12,7 +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.Returns information about the federation settings for the specified organization. +`Public Preview: please provide feedback `_: Returns information about the federation settings for the specified organization. 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. diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt index a5e3c55e98..3a45f7c8f7 100644 --- a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt @@ -12,7 +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.Returns one identity provider in the specified federation by the identity provider's id. +`Public Preview: please provide feedback `_: Returns one identity provider in the specified federation by the identity provider's id. 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. diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt index f9765b2b6c..b74f7fbc14 100644 --- a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt +++ b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt @@ -12,7 +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.Returns the metadata of one identity provider in the specified federation. +`Public Preview: please provide feedback `_: Returns the metadata of one identity provider in the specified federation. 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. diff --git a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt index d11bfa0b42..5d3a151ed3 100644 --- a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt @@ -12,7 +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.Returns one role mapping from the specified organization in the specified federation. +`Public Preview: please provide feedback `_: Returns one role mapping from the specified organization in the specified federation. 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. diff --git a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt index de7c0d3e53..5bf8868ee5 100644 --- a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt +++ b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt @@ -12,7 +12,7 @@ atlas api federatedAuthentication listConnectedOrgConfigs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all connected org configs in the specified federation.Returns all connected org configs in the specified federation. +`Public Preview: please provide feedback `_: Returns all connected org configs in the specified federation. 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. diff --git a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt index b59ddd5cc9..31f1d08cf9 100644 --- a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt +++ b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt @@ -12,7 +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.Returns all identity providers with the provided protocol and type in the specified federation. +`Public Preview: please provide feedback `_: Returns all identity providers with the provided protocol and type in the specified federation. 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. diff --git a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt index d70e0d2174..1bf6760069 100644 --- a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt +++ b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt @@ -12,7 +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.Returns all role mappings from the specified organization in the specified federation. +`Public Preview: please provide feedback `_: Returns all role mappings from the specified organization in the specified federation. 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. diff --git a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt index 42d6492f61..f172ec3d7a 100644 --- a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt @@ -12,7 +12,7 @@ atlas api federatedAuthentication removeConnectedOrgConfig :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one connected organization configuration from the specified federation.Removes one connected organization configuration from the specified federation. +`Public Preview: please provide feedback `_: Removes one connected organization configuration from the specified federation. 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. diff --git a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt index c7a6b55ffa..c308a52ec7 100644 --- a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt @@ -12,7 +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.Revokes the JWKS tokens from the requested OIDC identity provider. +`Public Preview: please provide feedback `_: Revokes the JWKS tokens from the requested OIDC identity provider. 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. diff --git a/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt index 74bb76c4c7..de8bcefac2 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt @@ -12,7 +12,7 @@ atlas api federatedAuthentication updateConnectedOrgConfig :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one connected organization configuration from the specified federation.Updates one connected organization configuration from the specified federation. +`Public Preview: please provide feedback `_: Updates one connected organization configuration from the specified federation. 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. diff --git a/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt index 0c5bc4aabb..d1f15920fa 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt @@ -12,7 +12,7 @@ atlas api federatedAuthentication updateIdentityProvider :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one identity provider in the specified federation.Updates one identity provider in the specified federation. +`Public Preview: please provide feedback `_: Updates one identity provider in the specified federation. 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. diff --git a/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt index 6cbfe36035..03877d83aa 100644 --- a/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt +++ b/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt @@ -12,7 +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.Updates one role mapping in the specified organization in the specified federation. +`Public Preview: please provide feedback `_: Updates one role mapping in the specified organization in the specified federation. 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. diff --git a/docs/command/atlas-api-federatedAuthentication.txt b/docs/command/atlas-api-federatedAuthentication.txt index 995c2ba558..fe3858d011 100644 --- a/docs/command/atlas-api-federatedAuthentication.txt +++ b/docs/command/atlas-api-federatedAuthentication.txt @@ -12,7 +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.Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. 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. @@ -56,24 +56,24 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-federatedAuthentication-createIdentityProvider` - `Public Preview: please provide feedback `_: Creates one identity provider within the specified federation.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.Updates one role mapping in the specified organization in the specified federation. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-flexClusters-createFlexCluster.txt b/docs/command/atlas-api-flexClusters-createFlexCluster.txt index dbcb5e6057..9ad973efab 100644 --- a/docs/command/atlas-api-flexClusters-createFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-createFlexCluster.txt @@ -12,7 +12,7 @@ atlas api flexClusters createFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one flex cluster in the specified project.Creates one flex cluster in the specified project. +`Public Preview: please provide feedback `_: Creates one flex cluster in the specified project. 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. diff --git a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt index 5cc682265d..14e91c7244 100644 --- a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt @@ -12,7 +12,7 @@ atlas api flexClusters deleteFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one flex cluster from the specified project.Removes one flex cluster from the specified project. +`Public Preview: please provide feedback `_: Removes one flex cluster from the specified project. 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. diff --git a/docs/command/atlas-api-flexClusters-getFlexCluster.txt b/docs/command/atlas-api-flexClusters-getFlexCluster.txt index 39bfde1903..5a89576ab3 100644 --- a/docs/command/atlas-api-flexClusters-getFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-getFlexCluster.txt @@ -12,7 +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.Returns details for one flex cluster in the specified project. +`Public Preview: please provide feedback `_: Returns details for one flex cluster in the specified project. 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. diff --git a/docs/command/atlas-api-flexClusters-listFlexClusters.txt b/docs/command/atlas-api-flexClusters-listFlexClusters.txt index 3daf0951b9..7d459df5ac 100644 --- a/docs/command/atlas-api-flexClusters-listFlexClusters.txt +++ b/docs/command/atlas-api-flexClusters-listFlexClusters.txt @@ -12,7 +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.Returns details for all flex clusters in the specified project. +`Public Preview: please provide feedback `_: Returns details for all flex clusters in the specified project. 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. diff --git a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt index 1311aac18a..fa746bd445 100644 --- a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt @@ -12,7 +12,7 @@ atlas api flexClusters updateFlexCluster :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one flex cluster in the specified project.Updates one flex cluster in the specified project. +`Public Preview: please provide feedback `_: Updates one flex cluster in the specified project. 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. diff --git a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt b/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt index 269f829e90..06871287af 100644 --- a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt +++ b/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt @@ -12,7 +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.Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. +`Public Preview: please provide feedback `_: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. 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. diff --git a/docs/command/atlas-api-flexClusters.txt b/docs/command/atlas-api-flexClusters.txt index d16b525313..26006f16d1 100644 --- a/docs/command/atlas-api-flexClusters.txt +++ b/docs/command/atlas-api-flexClusters.txt @@ -12,7 +12,7 @@ atlas api flexClusters :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes flex clusters.Returns, adds, edits, and removes flex clusters. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes flex clusters. 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. @@ -56,12 +56,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexClusters-createFlexCluster` - `Public Preview: please provide feedback `_: Creates one flex cluster in the specified project.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.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.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.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.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.Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt index 1b8bdfa00b..cc7aa3f0d2 100644 --- a/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt +++ b/docs/command/atlas-api-flexRestoreJobs-createFlexBackupRestoreJob.txt @@ -12,7 +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.Restores one snapshot of one flex cluster from the specified project. +`Public Preview: please provide feedback `_: Restores one snapshot of one flex cluster from the specified project. 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. diff --git a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt index 8f58aecd08..5976a2d64d 100644 --- a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt +++ b/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt @@ -12,7 +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.Returns one restore job for one flex cluster from the specified project. +`Public Preview: please provide feedback `_: Returns one restore job for one flex cluster from the specified project. 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. diff --git a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt index 746e7977de..59f2179796 100644 --- a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt +++ b/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt @@ -12,7 +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.Returns all restore jobs for one flex cluster from the specified project. +`Public Preview: please provide feedback `_: Returns all restore jobs for one flex cluster from the specified project. 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. diff --git a/docs/command/atlas-api-flexRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs.txt index 27655277bd..60d27b2e76 100644 --- a/docs/command/atlas-api-flexRestoreJobs.txt +++ b/docs/command/atlas-api-flexRestoreJobs.txt @@ -12,7 +12,7 @@ atlas api flexRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns and adds restore jobs for flex database deployments.Returns and adds restore jobs for flex database deployments. +`Public Preview: please provide feedback `_: Returns and adds restore jobs for flex database deployments. 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. @@ -56,9 +56,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.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.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.Returns all restore jobs for one flex cluster from the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt b/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt index bdc54ecbb6..2ba61c8909 100644 --- a/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt +++ b/docs/command/atlas-api-flexSnapshots-downloadFlexBackup.txt @@ -12,7 +12,7 @@ atlas api flexSnapshots downloadFlexBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Requests one snapshot for the specified flex cluster.Requests one snapshot for the specified flex cluster. +`Public Preview: please provide feedback `_: Requests one snapshot for the specified flex cluster. 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. diff --git a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt b/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt index ae7dcb72cc..89c4a960be 100644 --- a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt +++ b/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt @@ -12,7 +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.Returns one snapshot of one flex cluster from the specified project. +`Public Preview: please provide feedback `_: Returns one snapshot of one flex cluster from the specified project. 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. diff --git a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt b/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt index 5914933355..fea9a62048 100644 --- a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt +++ b/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt @@ -12,7 +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.Returns all snapshots of one flex cluster from the specified project. +`Public Preview: please provide feedback `_: Returns all snapshots of one flex cluster from the specified project. 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. diff --git a/docs/command/atlas-api-flexSnapshots.txt b/docs/command/atlas-api-flexSnapshots.txt index 261b6f7fea..68eed67439 100644 --- a/docs/command/atlas-api-flexSnapshots.txt +++ b/docs/command/atlas-api-flexSnapshots.txt @@ -12,7 +12,7 @@ atlas api flexSnapshots :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns and requests to download flex database deployment snapshots.Returns and requests to download flex database deployment snapshots. +`Public Preview: please provide feedback `_: Returns and requests to download flex database deployment snapshots. 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. @@ -56,9 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexSnapshots-downloadFlexBackup` - `Public Preview: please provide feedback `_: Requests one snapshot for the specified flex cluster.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.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.Returns all snapshots of one flex cluster from the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt b/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt index abb740dbeb..dd48c0a2db 100644 --- a/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt +++ b/docs/command/atlas-api-globalClusters-createCustomZoneMapping.txt @@ -12,7 +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.Creates one custom zone mapping for the specified global cluster. +`Public Preview: please provide feedback `_: Creates one custom zone mapping for the specified global cluster. 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. diff --git a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt index 86429836a8..836a0e506c 100644 --- a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt @@ -12,7 +12,7 @@ atlas api globalClusters createManagedNamespace :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one managed namespace within the specified global cluster.Creates one managed namespace within the specified global cluster. +`Public Preview: please provide feedback `_: Creates one managed namespace within the specified global cluster. 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. diff --git a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt b/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt index cb9b5efecf..e84ef6d3c7 100644 --- a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt +++ b/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt @@ -12,7 +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.Removes all custom zone mappings for the specified global cluster. +`Public Preview: please provide feedback `_: Removes all custom zone mappings for the specified global cluster. 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. diff --git a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt b/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt index b552438c83..62652b0005 100644 --- a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt @@ -12,7 +12,7 @@ atlas api globalClusters deleteManagedNamespace :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one managed namespace within the specified global cluster.Removes one managed namespace within the specified global cluster. +`Public Preview: please provide feedback `_: Removes one managed namespace within the specified global cluster. 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. diff --git a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt b/docs/command/atlas-api-globalClusters-getManagedNamespace.txt index 633ac8d16d..216ecbbd1b 100644 --- a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt +++ b/docs/command/atlas-api-globalClusters-getManagedNamespace.txt @@ -12,7 +12,7 @@ atlas api globalClusters getManagedNamespace :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one managed namespace within the specified global cluster.Returns one managed namespace within the specified global cluster. +`Public Preview: please provide feedback `_: Returns one managed namespace within the specified global cluster. 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. diff --git a/docs/command/atlas-api-globalClusters.txt b/docs/command/atlas-api-globalClusters.txt index 3a3f4f5b24..61febfcba7 100644 --- a/docs/command/atlas-api-globalClusters.txt +++ b/docs/command/atlas-api-globalClusters.txt @@ -12,7 +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.Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. +`Public Preview: please provide feedback `_: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. 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. @@ -57,11 +57,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.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.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.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.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.Returns one managed namespace within the specified global cluster. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt b/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt index 9c65d1b010..5143f92118 100644 --- a/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt +++ b/docs/command/atlas-api-invoices-createCostExplorerQueryProcess.txt @@ -12,7 +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.Creates a query process within the Cost Explorer for the given parameters. +`Public Preview: please provide feedback `_: Creates a query process within the Cost Explorer for the given parameters. 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. diff --git a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt b/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt index 522023be57..9faae27c4f 100644 --- a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt +++ b/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt @@ -12,7 +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.Returns one invoice that MongoDB issued to the specified organization in CSV format. +`Public Preview: please provide feedback `_: Returns one invoice that MongoDB issued to the specified organization in CSV format. 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. diff --git a/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt b/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt index d2b2e71db4..52cdf5b434 100644 --- a/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt +++ b/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt @@ -12,7 +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.Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. +`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. 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. diff --git a/docs/command/atlas-api-invoices-getInvoice.txt b/docs/command/atlas-api-invoices-getInvoice.txt index 84e040e47d..1fc096b9d8 100644 --- a/docs/command/atlas-api-invoices-getInvoice.txt +++ b/docs/command/atlas-api-invoices-getInvoice.txt @@ -12,7 +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.Returns one invoice that MongoDB issued to the specified organization. +`Public Preview: please provide feedback `_: Returns one invoice that MongoDB issued to the specified organization. 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. diff --git a/docs/command/atlas-api-invoices-listInvoices.txt b/docs/command/atlas-api-invoices-listInvoices.txt index c0fbccb1d4..39093e0cb2 100644 --- a/docs/command/atlas-api-invoices-listInvoices.txt +++ b/docs/command/atlas-api-invoices-listInvoices.txt @@ -12,7 +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.Returns all invoices that MongoDB issued to the specified organization. +`Public Preview: please provide feedback `_: Returns all invoices that MongoDB issued to the specified organization. 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. diff --git a/docs/command/atlas-api-invoices-listPendingInvoices.txt b/docs/command/atlas-api-invoices-listPendingInvoices.txt index ac35c306b8..5554d0cf0a 100644 --- a/docs/command/atlas-api-invoices-listPendingInvoices.txt +++ b/docs/command/atlas-api-invoices-listPendingInvoices.txt @@ -12,7 +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.Returns all invoices accruing charges for the current billing cycle for the specified organization. +`Public Preview: please provide feedback `_: Returns all invoices accruing charges for the current billing cycle for the specified organization. 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. diff --git a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt b/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt index 5569b7baf8..825e02001c 100644 --- a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt +++ b/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt @@ -12,7 +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.Query the lineItems of the specified invoice and return the result JSON. +`Public Preview: please provide feedback `_: Query the lineItems of the specified invoice and return the result JSON. 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. diff --git a/docs/command/atlas-api-invoices.txt b/docs/command/atlas-api-invoices.txt index 69a6b04e5c..4918bd1119 100644 --- a/docs/command/atlas-api-invoices.txt +++ b/docs/command/atlas-api-invoices.txt @@ -12,7 +12,7 @@ atlas api invoices :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns invoices.Returns invoices. +`Public Preview: please provide feedback `_: Returns invoices. 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. @@ -56,13 +56,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.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.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.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.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.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.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.Query the lineItems of the specified invoice and return the result JSON. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt index 3ee5d16f42..5235e6253e 100644 --- a/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-deleteLdapConfiguration.txt @@ -12,7 +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.Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. +`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. 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. diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt index befd3b7346..dadc5f730e 100644 --- a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt @@ -12,7 +12,7 @@ atlas api ldapConfiguration getLdapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the current LDAP configuration for the specified project.Returns the current LDAP configuration for the specified project. +`Public Preview: please provide feedback `_: Returns the current LDAP configuration for the specified project. 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. diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt index 704746bc24..296155dbe8 100644 --- a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt +++ b/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt @@ -12,7 +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.Returns the status of one request to verify one LDAP configuration for the specified project. +`Public Preview: please provide feedback `_: Returns the status of one request to verify one LDAP configuration for the specified project. 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. diff --git a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt index aa5ded52bb..ed91005234 100644 --- a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt @@ -12,7 +12,7 @@ atlas api ldapConfiguration saveLdapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Edits the LDAP configuration for the specified project.Edits the LDAP configuration for the specified project. +`Public Preview: please provide feedback `_: Edits the LDAP configuration for the specified project. 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. diff --git a/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt index d474467831..8e18612f05 100644 --- a/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt @@ -12,7 +12,7 @@ atlas api ldapConfiguration verifyLdapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Verifies the LDAP configuration for the specified project.Verifies the LDAP configuration for the specified project. +`Public Preview: please provide feedback `_: Verifies the LDAP configuration for the specified project. 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. diff --git a/docs/command/atlas-api-ldapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration.txt index c43cddae3e..c56abd5261 100644 --- a/docs/command/atlas-api-ldapConfiguration.txt +++ b/docs/command/atlas-api-ldapConfiguration.txt @@ -12,7 +12,7 @@ atlas api ldapConfiguration :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, edits, verifies, and removes LDAP configurations.Returns, edits, verifies, and removes LDAP configurations. +`Public Preview: please provide feedback `_: Returns, edits, verifies, and removes LDAP configurations. 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. @@ -56,11 +56,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.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.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.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.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.Verifies the LDAP configuration for the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt b/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt index 43ef4db7fc..b031878d07 100644 --- a/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt +++ b/docs/command/atlas-api-legacyBackup-createLegacyBackupRestoreJob.txt @@ -12,7 +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.Restores one legacy backup for one cluster in the specified project. +`Public Preview: please provide feedback `_: Restores one legacy backup for one cluster in the specified project. 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. diff --git a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt index eaca4f2afc..6c35abdb0f 100644 --- a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt +++ b/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt @@ -12,7 +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.Removes one legacy backup snapshot for one cluster in the specified project. +`Public Preview: please provide feedback `_: Removes one legacy backup snapshot for one cluster in the specified project. 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. diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt index 55ec97aae5..ead0159c52 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt @@ -12,7 +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.Returns one legacy backup checkpoint for one cluster in the specified project. +`Public Preview: please provide feedback `_: Returns one legacy backup checkpoint for one cluster in the specified project. 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. diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt index b1ba6a7959..07b2ef6ff9 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt @@ -12,7 +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.Returns one legacy backup restore job for one cluster in the specified project. +`Public Preview: please provide feedback `_: Returns one legacy backup restore job for one cluster in the specified project. 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. diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt index f5b2ded3f1..50ee7fc73e 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt @@ -12,7 +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.Returns one legacy backup snapshot for one cluster in the specified project. +`Public Preview: please provide feedback `_: Returns one legacy backup snapshot for one cluster in the specified project. 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. diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt index c4b7447b5c..71b67a5f32 100644 --- a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt +++ b/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt @@ -12,7 +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.Returns the snapshot schedule for one cluster in the specified project. +`Public Preview: please provide feedback `_: Returns the snapshot schedule for one cluster in the specified project. 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. diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt index 36d9717e71..1462154811 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt @@ -12,7 +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.Returns all legacy backup checkpoints for one cluster in the specified project. +`Public Preview: please provide feedback `_: Returns all legacy backup checkpoints for one cluster in the specified project. 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. diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt index bf40f5ba53..6aa0034030 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt @@ -12,7 +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.Returns all legacy backup restore jobs for one cluster in the specified project. +`Public Preview: please provide feedback `_: Returns all legacy backup restore jobs for one cluster in the specified project. 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. diff --git a/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt b/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt index f16ce9f361..62e6f96010 100644 --- a/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt +++ b/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt @@ -12,7 +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.Returns all legacy backup snapshots for one cluster in the specified project. +`Public Preview: please provide feedback `_: Returns all legacy backup snapshots for one cluster in the specified project. 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. diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt index 7049f045b3..98f6d6b207 100644 --- a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt +++ b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt @@ -12,7 +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.Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. +`Public Preview: please provide feedback `_: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. 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. diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt index f86e751be5..02367dead1 100644 --- a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt +++ b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt @@ -12,7 +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.Updates the snapshot schedule for one cluster in the specified project. +`Public Preview: please provide feedback `_: Updates the snapshot schedule for one cluster in the specified project. 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. diff --git a/docs/command/atlas-api-legacyBackup.txt b/docs/command/atlas-api-legacyBackup.txt index cb8bce3fe6..305203aafc 100644 --- a/docs/command/atlas-api-legacyBackup.txt +++ b/docs/command/atlas-api-legacyBackup.txt @@ -12,7 +12,7 @@ atlas api legacyBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints.Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. +`Public Preview: please provide feedback `_: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. 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. @@ -56,17 +56,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.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.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.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.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.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.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.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.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.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.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.Updates the snapshot schedule for one cluster in the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt index 6f623fa78e..5cf1fe2e1f 100644 --- a/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-deferMaintenanceWindow.txt @@ -12,7 +12,7 @@ atlas api maintenanceWindows deferMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Defers the maintenance window for the specified project.Defers the maintenance window for the specified project. +`Public Preview: please provide feedback `_: Defers the maintenance window for the specified project. 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. diff --git a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt index 8e60aa9a4c..6405339c99 100644 --- a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt @@ -12,7 +12,7 @@ atlas api maintenanceWindows getMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the maintenance window for the specified project.Returns the maintenance window for the specified project. +`Public Preview: please provide feedback `_: Returns the maintenance window for the specified project. 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. diff --git a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt index e1da3cb670..4d21ca22f2 100644 --- a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt @@ -12,7 +12,7 @@ atlas api maintenanceWindows resetMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Resets the maintenance window for the specified project.Resets the maintenance window for the specified project. +`Public Preview: please provide feedback `_: Resets the maintenance window for the specified project. 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. diff --git a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt index 3e16734825..8849ffdc79 100644 --- a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt +++ b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt @@ -12,7 +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.Toggles automatic deferral of the maintenance window for the specified project. +`Public Preview: please provide feedback `_: Toggles automatic deferral of the maintenance window for the specified project. 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. diff --git a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt index 1c6217ad0f..24b7e7e476 100644 --- a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt +++ b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt @@ -12,7 +12,7 @@ atlas api maintenanceWindows updateMaintenanceWindow :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the maintenance window for the specified project.Updates the maintenance window for the specified project. +`Public Preview: please provide feedback `_: Updates the maintenance window for the specified project. 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. diff --git a/docs/command/atlas-api-maintenanceWindows.txt b/docs/command/atlas-api-maintenanceWindows.txt index 1f20cf0fde..85b2397da2 100644 --- a/docs/command/atlas-api-maintenanceWindows.txt +++ b/docs/command/atlas-api-maintenanceWindows.txt @@ -12,7 +12,7 @@ atlas api maintenanceWindows :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, edits, and removes maintenance windows.Returns, edits, and removes maintenance windows. +`Public Preview: please provide feedback `_: Returns, edits, and removes maintenance windows. 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. @@ -56,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-maintenanceWindows-deferMaintenanceWindow` - `Public Preview: please provide feedback `_: Defers the maintenance window for the specified project.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.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.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.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.Updates the maintenance window for the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt index 1bf90b8387..938d872075 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addOrganizationRole.txt @@ -12,7 +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.Adds one organization-level role to the MongoDB Cloud user. +`Public Preview: please provide feedback `_: Adds one organization-level role to the MongoDB Cloud user. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt index 212843dd57..22a58471c2 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt @@ -12,7 +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.Adds one project-level role to the MongoDB Cloud user. +`Public Preview: please provide feedback `_: Adds one project-level role to the MongoDB Cloud user. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt index c6d6904f31..1c050c2376 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt @@ -12,7 +12,7 @@ atlas api mongoDbCloudUsers addProjectUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to one project.Adds one MongoDB Cloud user to one project. +`Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to one project. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt b/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt index afb1e86c69..f217ce6ef2 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt @@ -12,7 +12,7 @@ atlas api mongoDbCloudUsers addUserToTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to one team.Adds one MongoDB Cloud user to one team. +`Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to one team. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt index 67789ea68b..9d87235354 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt @@ -12,7 +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.Invites one new or existing MongoDB Cloud user to join the organization. +`Public Preview: please provide feedback `_: Invites one new or existing MongoDB Cloud user to join the organization. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt index a95f161da2..72c2f8a342 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt @@ -12,7 +12,7 @@ atlas api mongoDbCloudUsers createUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one MongoDB Cloud user account.Creates one MongoDB Cloud user account. +`Public Preview: please provide feedback `_: Creates one MongoDB Cloud user account. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt index df393ceae7..2756bd8a5b 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt @@ -12,7 +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.Returns information about the specified MongoDB Cloud user within the context of the specified organization. +`Public Preview: please provide feedback `_: Returns information about the specified MongoDB Cloud user within the context of the specified organization. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt index 0013c075c7..6b4c1d4097 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt @@ -12,7 +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.Returns information about the specified MongoDB Cloud user within the context of the specified project. +`Public Preview: please provide feedback `_: Returns information about the specified MongoDB Cloud user within the context of the specified project. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt index e570a549af..0d02445785 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt @@ -12,7 +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.Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. +`Public Preview: please provide feedback `_: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt index b07c9eb1a4..c3a7d54520 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt @@ -12,7 +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.Returns the details for one MongoDB Cloud user account with the specified username. +`Public Preview: please provide feedback `_: Returns the details for one MongoDB Cloud user account with the specified username. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt index dbeffeb8ba..286270a8a1 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listOrganizationUsers.txt @@ -12,7 +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.Returns details about the pending and active MongoDB Cloud users associated with the specified organization. +`Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified organization. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt index 09ec982c0f..ea9acd0aa0 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listProjectUsers.txt @@ -12,7 +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.Returns details about the pending and active MongoDB Cloud users associated with the specified project. +`Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified project. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt index 64f2912f54..d46df62064 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-listTeamUsers.txt @@ -12,7 +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.Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. +`Public Preview: please provide feedback `_: Returns details about the pending and active MongoDB Cloud users associated with the specified team in the organization. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt index b41cb5cf40..7929448f9f 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt @@ -12,7 +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.Removes one organization-level role from the MongoDB Cloud user. +`Public Preview: please provide feedback `_: Removes one organization-level role from the MongoDB Cloud user. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt index 97ab00eb16..73f7455a2c 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationUser.txt @@ -12,7 +12,7 @@ atlas api mongoDbCloudUsers removeOrganizationUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user in the specified organization.Removes one MongoDB Cloud user in the specified organization. +`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user in the specified organization. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt index 8a5eec441d..6249b60158 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt @@ -12,7 +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.Removes one project-level role from the MongoDB Cloud user. +`Public Preview: please provide feedback `_: Removes one project-level role from the MongoDB Cloud user. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt index b16cdc6c89..5f04240f28 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectUser.txt @@ -12,7 +12,7 @@ atlas api mongoDbCloudUsers removeProjectUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from the specified project.Removes one MongoDB Cloud user from the specified project. +`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from the specified project. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt index 54778d086f..d860ff389d 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt @@ -12,7 +12,7 @@ atlas api mongoDbCloudUsers removeUserFromTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from one team.Removes one MongoDB Cloud user from one team. +`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from one team. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt index d9db29a8a1..83fc8ba2fa 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt @@ -12,7 +12,7 @@ atlas api mongoDbCloudUsers updateOrganizationUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one MongoDB Cloud user in the specified organization.Updates one MongoDB Cloud user in the specified organization. +`Public Preview: please provide feedback `_: Updates one MongoDB Cloud user in the specified organization. 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. diff --git a/docs/command/atlas-api-mongoDbCloudUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers.txt index 0e029bc5ea..55ecbf811e 100644 --- a/docs/command/atlas-api-mongoDbCloudUsers.txt +++ b/docs/command/atlas-api-mongoDbCloudUsers.txt @@ -12,7 +12,7 @@ atlas api mongoDbCloudUsers :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, and edits MongoDB Cloud users.Returns, adds, and edits MongoDB Cloud users. +`Public Preview: please provide feedback `_: Returns, adds, and edits MongoDB Cloud users. 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. @@ -56,25 +56,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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.Updates one MongoDB Cloud user in the specified organization. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt b/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt index 24c9643802..ef0a8dd075 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getAtlasProcess.txt @@ -12,7 +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.Returns the processes for the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns the processes for the specified host for the specified project. 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. diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt index 2e4307549b..fdb236d5e4 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt @@ -12,7 +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.Returns one database running on the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns one database running on the specified host for the specified project. 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. diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt index 954f023c07..18efcdcc86 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt @@ -12,7 +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.Returns the measurements of one database for the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns the measurements of one database for the specified host for the specified project. 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. diff --git a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt index 1d7cdee5ee..549a2a6d07 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt @@ -12,7 +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.Returns the measurements of one disk or partition for the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns the measurements of one disk or partition for the specified host for the specified project. 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. diff --git a/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt b/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt index 371f72e6d4..594a5d2fb9 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getHostLogs.txt @@ -12,7 +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.Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. +`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. 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. diff --git a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt index 23cb259b59..2930f78e9f 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt @@ -12,7 +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.Returns disk, partition, or host measurements per process for the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns disk, partition, or host measurements per process for the specified host for the specified project. 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. diff --git a/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt b/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt index ad452a1b56..04b6e080aa 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getIndexMetrics.txt @@ -12,7 +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.Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. +`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. 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. diff --git a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt index 864890c179..33ea96c5b7 100644 --- a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt @@ -12,7 +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.Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. +`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. 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. diff --git a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt b/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt index bf9c0899bf..379ed66d1e 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt @@ -12,7 +12,7 @@ atlas api monitoringAndLogs listAtlasProcesses :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details of all processes for the specified project.Returns details of all processes for the specified project. +`Public Preview: please provide feedback `_: Returns details of all processes for the specified project. 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. diff --git a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt index 78c3232c21..8102e10cae 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt @@ -12,7 +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.Returns the list of databases running on the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns the list of databases running on the specified host for the specified project. 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. diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt index c5bb80d285..db5a49ffd3 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt @@ -12,7 +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.Returns measurement details for one disk or partition for the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns measurement details for one disk or partition for the specified host for the specified project. 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. diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt index cb6f8239b8..ea7013c9f2 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt @@ -12,7 +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.Returns the list of disks or partitions for the specified host for the specified project. +`Public Preview: please provide feedback `_: Returns the list of disks or partitions for the specified host for the specified project. 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. diff --git a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt b/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt index 034dab2799..6041dcd328 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt @@ -12,7 +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.Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. +`Public Preview: please provide feedback `_: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. 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. diff --git a/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt b/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt index e41f572b1b..e9571f5eea 100644 --- a/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt +++ b/docs/command/atlas-api-monitoringAndLogs-listMetricTypes.txt @@ -12,7 +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.Returns all Atlas Search metric types available for one process in the specified project. +`Public Preview: please provide feedback `_: Returns all Atlas Search metric types available for one process in the specified project. 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. diff --git a/docs/command/atlas-api-monitoringAndLogs.txt b/docs/command/atlas-api-monitoringAndLogs.txt index 37bc4d789b..9cbfd6e61d 100644 --- a/docs/command/atlas-api-monitoringAndLogs.txt +++ b/docs/command/atlas-api-monitoringAndLogs.txt @@ -12,7 +12,7 @@ atlas api monitoringAndLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns database deployment monitoring and logging data.Returns database deployment monitoring and logging data. +`Public Preview: please provide feedback `_: Returns database deployment monitoring and logging data. 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. @@ -56,20 +56,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.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.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.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.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.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.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.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.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.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.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.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.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.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.Returns all Atlas Search metric types available for one process in the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-networkPeering-createPeeringConnection.txt b/docs/command/atlas-api-networkPeering-createPeeringConnection.txt index f2b4cefeb2..6f9f78f7cb 100644 --- a/docs/command/atlas-api-networkPeering-createPeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-createPeeringConnection.txt @@ -12,7 +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.Creates one new network peering connection in the specified project. +`Public Preview: please provide feedback `_: Creates one new network peering connection in the specified project. 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. diff --git a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt b/docs/command/atlas-api-networkPeering-createPeeringContainer.txt index 68c2b5b05b..7567cd6053 100644 --- a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-createPeeringContainer.txt @@ -12,7 +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.Creates one new network peering container in the specified project. +`Public Preview: please provide feedback `_: Creates one new network peering container in the specified project. 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. diff --git a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt b/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt index adf4343da7..57ee871203 100644 --- a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt @@ -12,7 +12,7 @@ atlas api networkPeering deletePeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one network peering connection in the specified project.Removes one network peering connection in the specified project. +`Public Preview: please provide feedback `_: Removes one network peering connection in the specified project. 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. diff --git a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt b/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt index 586cdf30df..7cc9942455 100644 --- a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt @@ -12,7 +12,7 @@ atlas api networkPeering deletePeeringContainer :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one network peering container in the specified project.Removes one network peering container in the specified project. +`Public Preview: please provide feedback `_: Removes one network peering container in the specified project. 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. diff --git a/docs/command/atlas-api-networkPeering-disablePeering.txt b/docs/command/atlas-api-networkPeering-disablePeering.txt index a23b82ef2a..c4fc519f64 100644 --- a/docs/command/atlas-api-networkPeering-disablePeering.txt +++ b/docs/command/atlas-api-networkPeering-disablePeering.txt @@ -12,7 +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.Disables Connect via Peering Only mode for the specified project. +`Public Preview: please provide feedback `_: Disables Connect via Peering Only mode for the specified project. 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. diff --git a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt b/docs/command/atlas-api-networkPeering-getPeeringConnection.txt index 588baaa2b3..34d0e1f995 100644 --- a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-getPeeringConnection.txt @@ -12,7 +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.Returns details about one specified network peering connection in the specified project. +`Public Preview: please provide feedback `_: Returns details about one specified network peering connection in the specified project. 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. diff --git a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt b/docs/command/atlas-api-networkPeering-getPeeringContainer.txt index 438de6ade8..be545b86d5 100644 --- a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-getPeeringContainer.txt @@ -12,7 +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.Returns details about one network peering container in one specified project. +`Public Preview: please provide feedback `_: Returns details about one network peering container in one specified project. 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. diff --git a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt b/docs/command/atlas-api-networkPeering-listPeeringConnections.txt index af068d3a46..1ef7e84d0f 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringConnections.txt @@ -12,7 +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.Returns details about all network peering connections in the specified project. +`Public Preview: please provide feedback `_: Returns details about all network peering connections in the specified project. 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. diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt b/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt index 59af472b98..b5468370c6 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt @@ -12,7 +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.Returns details about all network peering containers in the specified project for the specified cloud provider. +`Public Preview: please provide feedback `_: Returns details about all network peering containers in the specified project for the specified cloud provider. 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. diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt b/docs/command/atlas-api-networkPeering-listPeeringContainers.txt index f9ec3617ed..286413665d 100644 --- a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt +++ b/docs/command/atlas-api-networkPeering-listPeeringContainers.txt @@ -12,7 +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.Returns details about all network peering containers in the specified project. +`Public Preview: please provide feedback `_: Returns details about all network peering containers in the specified project. 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. diff --git a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt b/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt index 8f0f3be943..6d79651bb8 100644 --- a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt +++ b/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt @@ -12,7 +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.Updates one specified network peering connection in the specified project. +`Public Preview: please provide feedback `_: Updates one specified network peering connection in the specified project. 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. diff --git a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt b/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt index 094c62c628..2be16fe42d 100644 --- a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt +++ b/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt @@ -12,7 +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.Updates the network details and labels of one specified network peering container in the specified project. +`Public Preview: please provide feedback `_: Updates the network details and labels of one specified network peering container in the specified project. 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. diff --git a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt b/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt index 77deb2ddbb..7bafed75d3 100644 --- a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt +++ b/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt @@ -12,7 +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.Verifies if someone set the specified project to Connect via Peering Only mode. +`Public Preview: please provide feedback `_: Verifies if someone set the specified project to Connect via Peering Only mode. 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. diff --git a/docs/command/atlas-api-networkPeering.txt b/docs/command/atlas-api-networkPeering.txt index f1a897f3c8..b7878bb5b8 100644 --- a/docs/command/atlas-api-networkPeering.txt +++ b/docs/command/atlas-api-networkPeering.txt @@ -12,7 +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.Returns, adds, edits, and removes network peering containers and peering connections. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes network peering containers and peering connections. 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. @@ -56,19 +56,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.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.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.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.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.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.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.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.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.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.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.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.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.Verifies if someone set the specified project to Connect via Peering Only mode. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt index b66c864642..ecb1f51743 100644 --- a/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-createOnlineArchive.txt @@ -12,7 +12,7 @@ atlas api onlineArchive createOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one online archive.Creates one online archive. +`Public Preview: please provide feedback `_: Creates one online archive. 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. diff --git a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt index 7d20d9c5f1..a7d65632ae 100644 --- a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt @@ -12,7 +12,7 @@ atlas api onlineArchive deleteOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one online archive.Removes one online archive. +`Public Preview: please provide feedback `_: Removes one online archive. 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. diff --git a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt b/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt index 6f81deec66..e957e3095a 100644 --- a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt +++ b/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt @@ -12,7 +12,7 @@ atlas api onlineArchive downloadOnlineArchiveQueryLogs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Downloads query logs for the specified online archive.Downloads query logs for the specified online archive. +`Public Preview: please provide feedback `_: Downloads query logs for the specified online archive. 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. diff --git a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt index d4da48c348..f3f7c23d22 100644 --- a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt @@ -12,7 +12,7 @@ atlas api onlineArchive getOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one online archive for one cluster.Returns one online archive for one cluster. +`Public Preview: please provide feedback `_: Returns one online archive for one cluster. 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. diff --git a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt index 5406149bc1..99dbcaf7b6 100644 --- a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt +++ b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt @@ -12,7 +12,7 @@ atlas api onlineArchive listOnlineArchives :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details of all online archives.Returns details of all online archives. +`Public Preview: please provide feedback `_: Returns details of all online archives. 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. diff --git a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt index 5b4ec26020..6751ffe7f0 100644 --- a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt @@ -12,7 +12,7 @@ atlas api onlineArchive updateOnlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates, pauses, or resumes one online archive.Updates, pauses, or resumes one online archive. +`Public Preview: please provide feedback `_: Updates, pauses, or resumes one online archive. 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. diff --git a/docs/command/atlas-api-onlineArchive.txt b/docs/command/atlas-api-onlineArchive.txt index 3ec784ad77..c739fb421f 100644 --- a/docs/command/atlas-api-onlineArchive.txt +++ b/docs/command/atlas-api-onlineArchive.txt @@ -12,7 +12,7 @@ atlas api onlineArchive :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, or removes an online archive.Returns, adds, edits, or removes an online archive. +`Public Preview: please provide feedback `_: Returns, adds, edits, or removes an online archive. 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. @@ -56,12 +56,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-onlineArchive-createOnlineArchive` - `Public Preview: please provide feedback `_: Creates one online archive.Creates one online archive. -* :ref:`atlas-api-onlineArchive-deleteOnlineArchive` - `Public Preview: please provide feedback `_: Removes one online archive.Removes one online archive. -* :ref:`atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs` - `Public Preview: please provide feedback `_: Downloads query logs for the specified online archive.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.Returns one online archive for one cluster. -* :ref:`atlas-api-onlineArchive-listOnlineArchives` - `Public Preview: please provide feedback `_: Returns details of all online archives.Returns details of all online archives. -* :ref:`atlas-api-onlineArchive-updateOnlineArchive` - `Public Preview: please provide feedback `_: Updates, pauses, or resumes one online archive.Updates, pauses, or resumes one online archive. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-organizations-createOrganization.txt b/docs/command/atlas-api-organizations-createOrganization.txt index 29ab30d827..e1c0df3930 100644 --- a/docs/command/atlas-api-organizations-createOrganization.txt +++ b/docs/command/atlas-api-organizations-createOrganization.txt @@ -12,7 +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.Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. +`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. 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. diff --git a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt b/docs/command/atlas-api-organizations-createOrganizationInvitation.txt index 72d10a88ba..ed8e5b9298 100644 --- a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-createOrganizationInvitation.txt @@ -12,7 +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.Invites one MongoDB Cloud user to join the specified organization. +`Public Preview: please provide feedback `_: Invites one MongoDB Cloud user to join the specified organization. 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. diff --git a/docs/command/atlas-api-organizations-deleteOrganization.txt b/docs/command/atlas-api-organizations-deleteOrganization.txt index 2215fa4f75..589a24f72b 100644 --- a/docs/command/atlas-api-organizations-deleteOrganization.txt +++ b/docs/command/atlas-api-organizations-deleteOrganization.txt @@ -12,7 +12,7 @@ atlas api organizations deleteOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one specified organization.Removes one specified organization. +`Public Preview: please provide feedback `_: Removes one specified organization. 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. diff --git a/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt b/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt index 801d3ea008..7a903076d1 100644 --- a/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-deleteOrganizationInvitation.txt @@ -12,7 +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.Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. +`Public Preview: please provide feedback `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. 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. diff --git a/docs/command/atlas-api-organizations-getOrganization.txt b/docs/command/atlas-api-organizations-getOrganization.txt index b6e9eb0048..0518154ce7 100644 --- a/docs/command/atlas-api-organizations-getOrganization.txt +++ b/docs/command/atlas-api-organizations-getOrganization.txt @@ -12,7 +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.Returns one organization to which the requesting Service Account or API Key has access. +`Public Preview: please provide feedback `_: Returns one organization to which the requesting Service Account or API Key has 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. diff --git a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt b/docs/command/atlas-api-organizations-getOrganizationInvitation.txt index 1c82f5263f..2ab06106c8 100644 --- a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-getOrganizationInvitation.txt @@ -12,7 +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.Returns the details of one pending invitation to the specified organization. +`Public Preview: please provide feedback `_: Returns the details of one pending invitation to the specified organization. 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. diff --git a/docs/command/atlas-api-organizations-getOrganizationSettings.txt b/docs/command/atlas-api-organizations-getOrganizationSettings.txt index 12b1084edd..5506cc7dbf 100644 --- a/docs/command/atlas-api-organizations-getOrganizationSettings.txt +++ b/docs/command/atlas-api-organizations-getOrganizationSettings.txt @@ -12,7 +12,7 @@ atlas api organizations getOrganizationSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details about the specified organization's settings.Returns details about the specified organization's settings. +`Public Preview: please provide feedback `_: Returns details about the specified organization's settings. 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. diff --git a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt index d88e608b4e..fa0527d55e 100644 --- a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt +++ b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt @@ -12,7 +12,7 @@ atlas api organizations listOrganizationInvitations :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all pending invitations to the specified organization.Returns all pending invitations to the specified organization. +`Public Preview: please provide feedback `_: Returns all pending invitations to the specified organization. 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. diff --git a/docs/command/atlas-api-organizations-listOrganizationProjects.txt b/docs/command/atlas-api-organizations-listOrganizationProjects.txt index 86c049f13c..185a627b00 100644 --- a/docs/command/atlas-api-organizations-listOrganizationProjects.txt +++ b/docs/command/atlas-api-organizations-listOrganizationProjects.txt @@ -12,7 +12,7 @@ atlas api organizations listOrganizationProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns multiple projects in the specified organization.Returns multiple projects in the specified organization. +`Public Preview: please provide feedback `_: Returns multiple projects in the specified organization. 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. diff --git a/docs/command/atlas-api-organizations-listOrganizations.txt b/docs/command/atlas-api-organizations-listOrganizations.txt index 8b98f953ef..a8ba02280a 100644 --- a/docs/command/atlas-api-organizations-listOrganizations.txt +++ b/docs/command/atlas-api-organizations-listOrganizations.txt @@ -12,7 +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.Returns all organizations to which the requesting Service Account or API Key has access. +`Public Preview: please provide feedback `_: Returns all organizations to which the requesting Service Account or API Key has 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. diff --git a/docs/command/atlas-api-organizations-updateOrganization.txt b/docs/command/atlas-api-organizations-updateOrganization.txt index c674c98936..c70cfe7d5e 100644 --- a/docs/command/atlas-api-organizations-updateOrganization.txt +++ b/docs/command/atlas-api-organizations-updateOrganization.txt @@ -12,7 +12,7 @@ atlas api organizations updateOrganization :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one organization.Updates one organization. +`Public Preview: please provide feedback `_: Updates one organization. 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. diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt index fd4f88f21a..283d76c759 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt @@ -12,7 +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.Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. +`Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified organization. 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. diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt index 1851857d5b..0476cc3f24 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt @@ -12,7 +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.Updates the details of one pending invitation, identified by its unique ID, to the specified organization. +`Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by its unique ID, to the specified organization. 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. diff --git a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt b/docs/command/atlas-api-organizations-updateOrganizationRoles.txt index 8417b1c215..fa3bf2577e 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationRoles.txt @@ -12,7 +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.Updates the roles of the specified user in the specified organization. +`Public Preview: please provide feedback `_: Updates the roles of the specified user in the specified organization. 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. diff --git a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt b/docs/command/atlas-api-organizations-updateOrganizationSettings.txt index 9ffba1bbe4..d11e5e6243 100644 --- a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt +++ b/docs/command/atlas-api-organizations-updateOrganizationSettings.txt @@ -12,7 +12,7 @@ atlas api organizations updateOrganizationSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the organization's settings.Updates the organization's settings. +`Public Preview: please provide feedback `_: Updates the organization's settings. 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. diff --git a/docs/command/atlas-api-organizations.txt b/docs/command/atlas-api-organizations.txt index f229d4ceec..426d78e481 100644 --- a/docs/command/atlas-api-organizations.txt +++ b/docs/command/atlas-api-organizations.txt @@ -12,7 +12,7 @@ atlas api organizations :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, and edits organizational units in MongoDB Cloud.Returns, adds, and edits organizational units in MongoDB Cloud. +`Public Preview: please provide feedback `_: Returns, adds, and edits organizational units in MongoDB Cloud. 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. @@ -56,21 +56,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.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.Invites one MongoDB Cloud user to join the specified organization. -* :ref:`atlas-api-organizations-deleteOrganization` - `Public Preview: please provide feedback `_: Removes one specified organization.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.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.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.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.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.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.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.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.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.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.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.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.Updates the organization's settings. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt b/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt index 0937373928..806b6cd349 100644 --- a/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt +++ b/docs/command/atlas-api-performanceAdvisor-disableSlowOperationThresholding.txt @@ -12,7 +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.Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. +`Public Preview: please provide feedback `_: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. 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. diff --git a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt b/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt index 1b4669f003..fe4f2f1468 100644 --- a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt +++ b/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt @@ -12,7 +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.Enables MongoDB Cloud to use its slow operation threshold for the specified project. +`Public Preview: please provide feedback `_: Enables MongoDB Cloud to use its slow operation threshold for the specified project. 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. diff --git a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt index 4ffdf4ba3a..0401233ff1 100644 --- a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt +++ b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt @@ -12,7 +12,7 @@ atlas api performanceAdvisor getManagedSlowMs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Get whether the Managed Slow MS feature is enabled.Get whether the Managed Slow MS feature is enabled. +`Public Preview: please provide feedback `_: Get whether the Managed Slow MS feature is enabled. 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. diff --git a/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt index 97a88189bd..243973bcd2 100644 --- a/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt +++ b/docs/command/atlas-api-performanceAdvisor-getServerlessAutoIndexing.txt @@ -12,7 +12,7 @@ atlas api performanceAdvisor getServerlessAutoIndexing :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Get whether the Serverless Auto Indexing feature is enabled.Get whether the Serverless Auto Indexing feature is enabled. +`Public Preview: please provide feedback `_: Get whether the Serverless Auto Indexing feature is enabled. 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. diff --git a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt index 64b09343f4..e28c193331 100644 --- a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt @@ -12,7 +12,7 @@ atlas api performanceAdvisor listClusterSuggestedIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests.Returns the indexes that the Performance Advisor suggests. +`Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests. 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. diff --git a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt index 076a76a903..b5c6f0423b 100644 --- a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt @@ -12,7 +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.Returns the indexes that the Performance Advisor suggests to drop. +`Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests to drop. 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. diff --git a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt index 29fe0d91ba..8ae098b1e4 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt @@ -12,7 +12,7 @@ atlas api performanceAdvisor listSchemaAdvice :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the schema suggestions that the Performance Advisor detects.Returns the schema suggestions that the Performance Advisor detects. +`Public Preview: please provide feedback `_: Returns the schema suggestions that the Performance Advisor detects. 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. diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt index 5559e11000..266699b2a3 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt @@ -12,7 +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.Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. +`Public Preview: please provide feedback `_: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. 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. diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt index 74ed0e75af..e1a6dcfb63 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt @@ -12,7 +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.Returns up to 20 namespaces for collections experiencing slow queries on the specified host. +`Public Preview: please provide feedback `_: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. 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. diff --git a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt index ca4ff96ed0..2fb009914c 100644 --- a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt +++ b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt @@ -12,7 +12,7 @@ atlas api performanceAdvisor listSuggestedIndexes :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests.Returns the indexes that the Performance Advisor suggests. +`Public Preview: please provide feedback `_: Returns the indexes that the Performance Advisor suggests. 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. diff --git a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt index 7c37e00edf..d52caa0ce1 100644 --- a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt +++ b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt @@ -12,7 +12,7 @@ atlas api performanceAdvisor setServerlessAutoIndexing :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Set whether the Serverless Auto Indexing feature is enabled.Set whether the Serverless Auto Indexing feature is enabled. +`Public Preview: please provide feedback `_: Set whether the Serverless Auto Indexing feature is enabled. 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. diff --git a/docs/command/atlas-api-performanceAdvisor.txt b/docs/command/atlas-api-performanceAdvisor.txt index 7e6c9f2d32..93dc2d2a30 100644 --- a/docs/command/atlas-api-performanceAdvisor.txt +++ b/docs/command/atlas-api-performanceAdvisor.txt @@ -12,7 +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.Returns suggested indexes and slow query data for a database deployment. +`Public Preview: please provide feedback `_: Returns suggested indexes and slow query data for a database deployment. 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. @@ -56,17 +56,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.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.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.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.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.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.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.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.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.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.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.Set whether the Serverless Auto Indexing feature is enabled. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt index 8e2e43e0fc..ec1fc35374 100644 --- a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpoint.txt @@ -12,7 +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.Creates one private endpoint for the specified cloud service provider. +`Public Preview: please provide feedback `_: Creates one private endpoint for the specified cloud service provider. 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. diff --git a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt index 07a9f05876..e13a2cc72d 100644 --- a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt @@ -12,7 +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.Creates one private endpoint service for the specified cloud service provider. +`Public Preview: please provide feedback `_: Creates one private endpoint service for the specified cloud service provider. 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. diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt index 917179bd82..c9e842afba 100644 --- a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt @@ -12,7 +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.Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. +`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. 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. diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt index 03cde18edb..f92f9e9ae8 100644 --- a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt @@ -12,7 +12,7 @@ atlas api privateEndpointServices deletePrivateEndpointService :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one private endpoint service from the specified project.Removes one private endpoint service from the specified project. +`Public Preview: please provide feedback `_: Removes one private endpoint service from the specified project. 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. diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt index 7dc4eea9a8..86ef631422 100644 --- a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt +++ b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt @@ -12,7 +12,7 @@ atlas api privateEndpointServices getPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the connection state of the specified private endpoint.Returns the connection state of the specified private endpoint. +`Public Preview: please provide feedback `_: Returns the connection state of the specified private endpoint. 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. diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt index b73c602d94..3caa103bf8 100644 --- a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt +++ b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt @@ -12,7 +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.Returns the name, interfaces, and state of the specified private endpoint service from one project. +`Public Preview: please provide feedback `_: Returns the name, interfaces, and state of the specified private endpoint service from one project. 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. diff --git a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt index 24b49ebbf1..8a0aeea8a8 100644 --- a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt +++ b/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt @@ -12,7 +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.Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. +`Public Preview: please provide feedback `_: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. 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. diff --git a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt index d3a700f2fb..18c0462e4b 100644 --- a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt +++ b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt @@ -12,7 +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.Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. +`Public Preview: please provide feedback `_: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. 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. diff --git a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt index 13d24545d2..2e9131b360 100644 --- a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt +++ b/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt @@ -12,7 +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.Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. +`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. 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. diff --git a/docs/command/atlas-api-privateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices.txt index 006bf36e18..12389df643 100644 --- a/docs/command/atlas-api-privateEndpointServices.txt +++ b/docs/command/atlas-api-privateEndpointServices.txt @@ -12,7 +12,7 @@ atlas api privateEndpointServices :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes private endpoint services.Returns, adds, edits, and removes private endpoint services. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes private endpoint services. 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. @@ -56,15 +56,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.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.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.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.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.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.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.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.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.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` - `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. .. toctree:: diff --git a/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt index 33403b1800..fb0bdcdce4 100644 --- a/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-addProjectApiKey.txt @@ -12,7 +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.Assigns the specified organization API key to the specified project. +`Public Preview: please provide feedback `_: Assigns the specified organization API key to the specified project. 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt index f696541de7..cc8d69078f 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt @@ -12,7 +12,7 @@ atlas api programmaticApiKeys createApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one API key for the specified organization.Creates one API key for the specified organization. +`Public Preview: please provide feedback `_: Creates one API key for the specified organization. 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt index 4dd1769f32..b8c16ecac4 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt @@ -12,7 +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.Creates the access list entries for the specified organization API key. +`Public Preview: please provide feedback `_: Creates the access list entries for the specified organization API key. 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt index 35278064ed..df00f90027 100644 --- a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt @@ -12,7 +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.Creates and assigns the specified organization API key to the specified project. +`Public Preview: please provide feedback `_: Creates and assigns the specified organization API key to the specified project. 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt index 3d954d830b..56718bd6b1 100644 --- a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt @@ -12,7 +12,7 @@ atlas api programmaticApiKeys deleteApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one organization API key from the specified organization.Removes one organization API key from the specified organization. +`Public Preview: please provide feedback `_: Removes one organization API key from the specified organization. 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt index aef0b0593b..24a229d11f 100644 --- a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt +++ b/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt @@ -12,7 +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.Removes the specified access list entry from the specified organization API key. +`Public Preview: please provide feedback `_: Removes the specified access list entry from the specified organization API key. 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt index 8bdb133a73..a2b431bf64 100644 --- a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt @@ -12,7 +12,7 @@ atlas api programmaticApiKeys getApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one organization API key.Returns one organization API key. +`Public Preview: please provide feedback `_: Returns one organization API key. 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt index 9ceff6426b..60b286c6d4 100644 --- a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt +++ b/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt @@ -12,7 +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.Returns one access list entry for the specified organization API key. +`Public Preview: please provide feedback `_: Returns one access list entry for the specified organization API key. 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt index 2f45f040bb..c58ffe5a73 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt @@ -12,7 +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.Returns all access list entries that you configured for the specified organization API key. +`Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified organization API key. 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt index 3645879bde..e719999329 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt @@ -12,7 +12,7 @@ atlas api programmaticApiKeys listApiKeys :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all organization API keys for the specified organization.Returns all organization API keys for the specified organization. +`Public Preview: please provide feedback `_: Returns all organization API keys for the specified organization. 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt index 2da5ac264b..bad6218592 100644 --- a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt @@ -12,7 +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.Returns all organization API keys that you assigned to the specified project. +`Public Preview: please provide feedback `_: Returns all organization API keys that you assigned to the specified project. 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt index e01de6ca50..3a0e0f06e3 100644 --- a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt @@ -12,7 +12,7 @@ atlas api programmaticApiKeys removeProjectApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one organization API key from the specified project.Removes one organization API key from the specified project. +`Public Preview: please provide feedback `_: Removes one organization API key from the specified project. 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt index 8a359b549f..693ddcce4e 100644 --- a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt +++ b/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt @@ -12,7 +12,7 @@ atlas api programmaticApiKeys updateApiKey :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one organization API key in the specified organization.Updates one organization API key in the specified organization. +`Public Preview: please provide feedback `_: Updates one organization API key in the specified organization. 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. diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt index 1001eae96f..ab6b34af5c 100644 --- a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt +++ b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt @@ -12,7 +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.Updates the roles of the organization API key that you specify for the project that you specify. +`Public Preview: please provide feedback `_: Updates the roles of the organization API key that you specify for the project that you specify. 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. diff --git a/docs/command/atlas-api-programmaticApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys.txt index 6190dd6365..e6e1889c48 100644 --- a/docs/command/atlas-api-programmaticApiKeys.txt +++ b/docs/command/atlas-api-programmaticApiKeys.txt @@ -12,7 +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.Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. 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. @@ -56,20 +56,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.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.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.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.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.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.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.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.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.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.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.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.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.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.Updates the roles of the organization API key that you specify for the project that you specify. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt index d23f002574..14873209dc 100644 --- a/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt @@ -12,7 +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.Adds one or more access list entries to the specified project. +`Public Preview: please provide feedback `_: Adds one or more access list entries to the specified project. 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. diff --git a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt index a5939bc708..57170c7f38 100644 --- a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt @@ -12,7 +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.Removes one access list entry from the specified project's IP access list. +`Public Preview: please provide feedback `_: Removes one access list entry from the specified project's IP access list. 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. diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt index 9b62b507b0..b8f758cbad 100644 --- a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt +++ b/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt @@ -12,7 +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.Returns the status of one project IP access list entry. +`Public Preview: please provide feedback `_: Returns the status of one project IP access list entry. 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. diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt index e31ca91cb2..6f171aeccc 100644 --- a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt +++ b/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt @@ -12,7 +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.Returns one access list entry from the specified project's IP access list. +`Public Preview: please provide feedback `_: Returns one access list entry from the specified project's IP access list. 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. diff --git a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt b/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt index f6a66afb27..b607f41776 100644 --- a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt +++ b/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt @@ -12,7 +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.Returns all access list entries from the specified project's IP access list. +`Public Preview: please provide feedback `_: Returns all access list entries from the specified project's IP access list. 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. diff --git a/docs/command/atlas-api-projectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList.txt index 299fee2f07..3dbbea9510 100644 --- a/docs/command/atlas-api-projectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList.txt @@ -12,7 +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.Returns, adds, edits, and removes network access limits to database deployments in Atlas. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes network access limits to database deployments in Atlas. 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. @@ -56,11 +56,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.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.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.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.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.Returns all access list entries from the specified project's IP access list. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-projects-addUserToProject.txt b/docs/command/atlas-api-projects-addUserToProject.txt index b4bd6489d7..a9d8f95c85 100644 --- a/docs/command/atlas-api-projects-addUserToProject.txt +++ b/docs/command/atlas-api-projects-addUserToProject.txt @@ -12,7 +12,7 @@ atlas api projects addUserToProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to the specified project.Adds one MongoDB Cloud user to the specified project. +`Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to the specified project. 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. diff --git a/docs/command/atlas-api-projects-createProject.txt b/docs/command/atlas-api-projects-createProject.txt index 1b25c8246d..6927e64f15 100644 --- a/docs/command/atlas-api-projects-createProject.txt +++ b/docs/command/atlas-api-projects-createProject.txt @@ -12,7 +12,7 @@ atlas api projects createProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one project.Creates one project. +`Public Preview: please provide feedback `_: Creates one project. 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. diff --git a/docs/command/atlas-api-projects-createProjectInvitation.txt b/docs/command/atlas-api-projects-createProjectInvitation.txt index 3e38f037bf..5ea321eeba 100644 --- a/docs/command/atlas-api-projects-createProjectInvitation.txt +++ b/docs/command/atlas-api-projects-createProjectInvitation.txt @@ -12,7 +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.Invites one MongoDB Cloud user to join the specified project. +`Public Preview: please provide feedback `_: Invites one MongoDB Cloud user to join the specified project. 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. diff --git a/docs/command/atlas-api-projects-deleteProject.txt b/docs/command/atlas-api-projects-deleteProject.txt index 2e61c71dad..b39c5240e7 100644 --- a/docs/command/atlas-api-projects-deleteProject.txt +++ b/docs/command/atlas-api-projects-deleteProject.txt @@ -12,7 +12,7 @@ atlas api projects deleteProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes the specified project.Removes the specified project. +`Public Preview: please provide feedback `_: Removes the specified project. 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. diff --git a/docs/command/atlas-api-projects-deleteProjectInvitation.txt b/docs/command/atlas-api-projects-deleteProjectInvitation.txt index f46842a6ff..7224c04b8c 100644 --- a/docs/command/atlas-api-projects-deleteProjectInvitation.txt +++ b/docs/command/atlas-api-projects-deleteProjectInvitation.txt @@ -12,7 +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.Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. +`Public Preview: please provide feedback `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. 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. diff --git a/docs/command/atlas-api-projects-deleteProjectLimit.txt b/docs/command/atlas-api-projects-deleteProjectLimit.txt index d4eb45b33c..f1be0de7d3 100644 --- a/docs/command/atlas-api-projects-deleteProjectLimit.txt +++ b/docs/command/atlas-api-projects-deleteProjectLimit.txt @@ -12,7 +12,7 @@ atlas api projects deleteProjectLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes the specified project limit.Removes the specified project limit. +`Public Preview: please provide feedback `_: Removes the specified project limit. 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. diff --git a/docs/command/atlas-api-projects-getProject.txt b/docs/command/atlas-api-projects-getProject.txt index 234a254b66..bd92235118 100644 --- a/docs/command/atlas-api-projects-getProject.txt +++ b/docs/command/atlas-api-projects-getProject.txt @@ -12,7 +12,7 @@ atlas api projects getProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details about the specified project.Returns details about the specified project. +`Public Preview: please provide feedback `_: Returns details about the specified project. 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. diff --git a/docs/command/atlas-api-projects-getProjectByName.txt b/docs/command/atlas-api-projects-getProjectByName.txt index b9d9d61a17..ff0befed2d 100644 --- a/docs/command/atlas-api-projects-getProjectByName.txt +++ b/docs/command/atlas-api-projects-getProjectByName.txt @@ -12,7 +12,7 @@ atlas api projects getProjectByName :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details about the project identified by its name.Returns details about the project identified by its name. +`Public Preview: please provide feedback `_: Returns details about the project identified by its name. 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. diff --git a/docs/command/atlas-api-projects-getProjectInvitation.txt b/docs/command/atlas-api-projects-getProjectInvitation.txt index 70687bc507..bd40a32e04 100644 --- a/docs/command/atlas-api-projects-getProjectInvitation.txt +++ b/docs/command/atlas-api-projects-getProjectInvitation.txt @@ -12,7 +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.Returns the details of one pending invitation to the specified project. +`Public Preview: please provide feedback `_: Returns the details of one pending invitation to the specified project. 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. diff --git a/docs/command/atlas-api-projects-getProjectLimit.txt b/docs/command/atlas-api-projects-getProjectLimit.txt index 7ed5bf9479..c257541757 100644 --- a/docs/command/atlas-api-projects-getProjectLimit.txt +++ b/docs/command/atlas-api-projects-getProjectLimit.txt @@ -12,7 +12,7 @@ atlas api projects getProjectLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the specified limit for the specified project.Returns the specified limit for the specified project. +`Public Preview: please provide feedback `_: Returns the specified limit for the specified project. 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. diff --git a/docs/command/atlas-api-projects-getProjectLtsVersions.txt b/docs/command/atlas-api-projects-getProjectLtsVersions.txt index ca3ff71404..ecdbb309c6 100644 --- a/docs/command/atlas-api-projects-getProjectLtsVersions.txt +++ b/docs/command/atlas-api-projects-getProjectLtsVersions.txt @@ -12,7 +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.Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. +`Public Preview: please provide feedback `_: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. 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. diff --git a/docs/command/atlas-api-projects-getProjectSettings.txt b/docs/command/atlas-api-projects-getProjectSettings.txt index 27ef37a5a4..4e965de496 100644 --- a/docs/command/atlas-api-projects-getProjectSettings.txt +++ b/docs/command/atlas-api-projects-getProjectSettings.txt @@ -12,7 +12,7 @@ atlas api projects getProjectSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details about the specified project's settings.Returns details about the specified project's settings. +`Public Preview: please provide feedback `_: Returns details about the specified project's settings. 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. diff --git a/docs/command/atlas-api-projects-listProjectInvitations.txt b/docs/command/atlas-api-projects-listProjectInvitations.txt index 3982129280..1e0ba19ded 100644 --- a/docs/command/atlas-api-projects-listProjectInvitations.txt +++ b/docs/command/atlas-api-projects-listProjectInvitations.txt @@ -12,7 +12,7 @@ atlas api projects listProjectInvitations :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all pending invitations to the specified project.Returns all pending invitations to the specified project. +`Public Preview: please provide feedback `_: Returns all pending invitations to the specified project. 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. diff --git a/docs/command/atlas-api-projects-listProjectLimits.txt b/docs/command/atlas-api-projects-listProjectLimits.txt index dcbae6102a..6dbec8413e 100644 --- a/docs/command/atlas-api-projects-listProjectLimits.txt +++ b/docs/command/atlas-api-projects-listProjectLimits.txt @@ -12,7 +12,7 @@ atlas api projects listProjectLimits :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all the limits for the specified project.Returns all the limits for the specified project. +`Public Preview: please provide feedback `_: Returns all the limits for the specified project. 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. diff --git a/docs/command/atlas-api-projects-listProjects.txt b/docs/command/atlas-api-projects-listProjects.txt index b3e2a8f896..f37dd3c1f7 100644 --- a/docs/command/atlas-api-projects-listProjects.txt +++ b/docs/command/atlas-api-projects-listProjects.txt @@ -12,7 +12,7 @@ atlas api projects listProjects :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns details about all projects.Returns details about all projects. +`Public Preview: please provide feedback `_: Returns details about all projects. 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. diff --git a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt b/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt index eb268562cf..305d0a15bc 100644 --- a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt +++ b/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt @@ -12,7 +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.Migrates a project from its current organization to another organization. +`Public Preview: please provide feedback `_: Migrates a project from its current organization to another organization. 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. diff --git a/docs/command/atlas-api-projects-returnAllIpAddresses.txt b/docs/command/atlas-api-projects-returnAllIpAddresses.txt index 53b23ff3a6..57fd4d2a4c 100644 --- a/docs/command/atlas-api-projects-returnAllIpAddresses.txt +++ b/docs/command/atlas-api-projects-returnAllIpAddresses.txt @@ -12,7 +12,7 @@ atlas api projects returnAllIpAddresses :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all IP addresses for this project.Returns all IP addresses for this project. +`Public Preview: please provide feedback `_: Returns all IP addresses for this project. 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. diff --git a/docs/command/atlas-api-projects-setProjectLimit.txt b/docs/command/atlas-api-projects-setProjectLimit.txt index b123e43998..c7329dcdf7 100644 --- a/docs/command/atlas-api-projects-setProjectLimit.txt +++ b/docs/command/atlas-api-projects-setProjectLimit.txt @@ -12,7 +12,7 @@ atlas api projects setProjectLimit :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Sets the specified project limit.Sets the specified project limit. +`Public Preview: please provide feedback `_: Sets the specified project limit. 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. diff --git a/docs/command/atlas-api-projects-updateProject.txt b/docs/command/atlas-api-projects-updateProject.txt index 56f56cf293..6d7f494758 100644 --- a/docs/command/atlas-api-projects-updateProject.txt +++ b/docs/command/atlas-api-projects-updateProject.txt @@ -12,7 +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.Updates the human-readable label that identifies the specified project, or the tags associated with the project. +`Public Preview: please provide feedback `_: Updates the human-readable label that identifies the specified project, or the tags associated with the project. 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. diff --git a/docs/command/atlas-api-projects-updateProjectInvitation.txt b/docs/command/atlas-api-projects-updateProjectInvitation.txt index 43895c2172..0331b8f602 100644 --- a/docs/command/atlas-api-projects-updateProjectInvitation.txt +++ b/docs/command/atlas-api-projects-updateProjectInvitation.txt @@ -12,7 +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.Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. +`Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by the username of the invited user, to the specified project. 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. diff --git a/docs/command/atlas-api-projects-updateProjectInvitationById.txt b/docs/command/atlas-api-projects-updateProjectInvitationById.txt index 223eddf95b..fbb0a468ef 100644 --- a/docs/command/atlas-api-projects-updateProjectInvitationById.txt +++ b/docs/command/atlas-api-projects-updateProjectInvitationById.txt @@ -12,7 +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.Updates the details of one pending invitation, identified by its unique ID, to the specified project. +`Public Preview: please provide feedback `_: Updates the details of one pending invitation, identified by its unique ID, to the specified project. 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. diff --git a/docs/command/atlas-api-projects-updateProjectRoles.txt b/docs/command/atlas-api-projects-updateProjectRoles.txt index f5548b661d..775488b1dc 100644 --- a/docs/command/atlas-api-projects-updateProjectRoles.txt +++ b/docs/command/atlas-api-projects-updateProjectRoles.txt @@ -12,7 +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.Updates the roles of the specified user in the specified project. +`Public Preview: please provide feedback `_: Updates the roles of the specified user in the specified project. 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. diff --git a/docs/command/atlas-api-projects-updateProjectSettings.txt b/docs/command/atlas-api-projects-updateProjectSettings.txt index 0ea8958995..294ca53b21 100644 --- a/docs/command/atlas-api-projects-updateProjectSettings.txt +++ b/docs/command/atlas-api-projects-updateProjectSettings.txt @@ -12,7 +12,7 @@ atlas api projects updateProjectSettings :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the settings of the specified project.Updates the settings of the specified project. +`Public Preview: please provide feedback `_: Updates the settings of the specified project. 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. diff --git a/docs/command/atlas-api-projects.txt b/docs/command/atlas-api-projects.txt index 72045d9682..b54857656f 100644 --- a/docs/command/atlas-api-projects.txt +++ b/docs/command/atlas-api-projects.txt @@ -12,7 +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.Returns, adds, and edits collections of clusters and users in MongoDB Cloud. +`Public Preview: please provide feedback `_: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. 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. @@ -56,29 +56,29 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projects-addUserToProject` - `Public Preview: please provide feedback `_: Adds one MongoDB Cloud user to the specified project.Adds one MongoDB Cloud user to the specified project. -* :ref:`atlas-api-projects-createProject` - `Public Preview: please provide feedback `_: Creates one project.Creates one project. -* :ref:`atlas-api-projects-createProjectInvitation` - `Public Preview: please provide feedback `_: Invites one MongoDB Cloud user to join the specified project.Invites one MongoDB Cloud user to join the specified project. -* :ref:`atlas-api-projects-deleteProject` - `Public Preview: please provide feedback `_: Removes the specified project.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.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.Removes the specified project limit. -* :ref:`atlas-api-projects-getProject` - `Public Preview: please provide feedback `_: Returns details about the specified project.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.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.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.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.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.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.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.Returns all the limits for the specified project. -* :ref:`atlas-api-projects-listProjects` - `Public Preview: please provide feedback `_: Returns details about all projects.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.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.Returns all IP addresses for this project. -* :ref:`atlas-api-projects-setProjectLimit` - `Public Preview: please provide feedback `_: Sets the specified project limit.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.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.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.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.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.Updates the settings of the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt index 0f9bbf9893..4df2c65d42 100644 --- a/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-createPushBasedLogConfiguration.txt @@ -12,7 +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.Configures the project level settings for the push-based log export feature. +`Public Preview: please provide feedback `_: Configures the project level settings for the push-based log export feature. 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. diff --git a/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt index fbc26db6c0..7dd590b44d 100644 --- a/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration.txt @@ -12,7 +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.Disables the push-based log export feature by resetting the project level settings to its default configuration. +`Public Preview: please provide feedback `_: Disables the push-based log export feature by resetting the project level settings to its default configuration. 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. diff --git a/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt index cd4f5e4a8b..6be515c9a1 100644 --- a/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-getPushBasedLogConfiguration.txt @@ -12,7 +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.Fetches the current project level settings for the push-based log export feature. +`Public Preview: please provide feedback `_: Fetches the current project level settings for the push-based log export feature. 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. diff --git a/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt b/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt index 23afd1407a..a81705f599 100644 --- a/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt +++ b/docs/command/atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration.txt @@ -12,7 +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.Updates the project level settings for the push-based log export feature. +`Public Preview: please provide feedback `_: Updates the project level settings for the push-based log export feature. 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. diff --git a/docs/command/atlas-api-pushBasedLogExport.txt b/docs/command/atlas-api-pushBasedLogExport.txt index 2c86c299cd..4a27e38c73 100644 --- a/docs/command/atlas-api-pushBasedLogExport.txt +++ b/docs/command/atlas-api-pushBasedLogExport.txt @@ -12,7 +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.You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. +`Public Preview: please provide feedback `_: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. 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. @@ -56,10 +56,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.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.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.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.Updates the project level settings for the push-based log export feature. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt index 62facd3b35..901de65a0c 100644 --- a/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt @@ -12,7 +12,7 @@ atlas api resourcePolicies createAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Create one Atlas Resource Policy for an org.Create one Atlas Resource Policy for an org. +`Public Preview: please provide feedback `_: Create one Atlas Resource Policy for an org. 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. diff --git a/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt index c116be78cd..dbdb6d9935 100644 --- a/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt @@ -12,7 +12,7 @@ atlas api resourcePolicies deleteAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Delete one Atlas Resource Policy for an org.Delete one Atlas Resource Policy for an org. +`Public Preview: please provide feedback `_: Delete one Atlas Resource Policy for an org. 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. diff --git a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt index b211968823..906be30f6d 100644 --- a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt @@ -12,7 +12,7 @@ atlas api resourcePolicies getAtlasResourcePolicies :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Return all Atlas Resource Policies for the org.Return all Atlas Resource Policies for the org. +`Public Preview: please provide feedback `_: Return all Atlas Resource Policies for the org. 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. diff --git a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt index 2d94c21f46..349824f9c3 100644 --- a/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt @@ -12,7 +12,7 @@ atlas api resourcePolicies getAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Return one Atlas Resource Policy for an org.Return one Atlas Resource Policy for an org. +`Public Preview: please provide feedback `_: Return one Atlas Resource Policy for an org. 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. diff --git a/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt b/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt index 7ff6a68e35..3d71862c56 100644 --- a/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt +++ b/docs/command/atlas-api-resourcePolicies-getResourcesNonCompliant.txt @@ -12,7 +12,7 @@ atlas api resourcePolicies getResourcesNonCompliant :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Return all non-compliant resources for an org.Return all non-compliant resources for an org. +`Public Preview: please provide feedback `_: Return all non-compliant resources for an org. 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. diff --git a/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt index 1dffc53db3..2f95973b68 100644 --- a/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt @@ -12,7 +12,7 @@ atlas api resourcePolicies updateAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Update one Atlas Resource Policy for an org.Update one Atlas Resource Policy for an org. +`Public Preview: please provide feedback `_: Update one Atlas Resource Policy for an org. 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. diff --git a/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt b/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt index 99c7854f02..4a846de4ff 100644 --- a/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt +++ b/docs/command/atlas-api-resourcePolicies-validateAtlasResourcePolicy.txt @@ -12,7 +12,7 @@ atlas api resourcePolicies validateAtlasResourcePolicy :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Validate one Atlas Resource Policy for an org.Validate one Atlas Resource Policy for an org. +`Public Preview: please provide feedback `_: Validate one Atlas Resource Policy for an org. 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. diff --git a/docs/command/atlas-api-resourcePolicies.txt b/docs/command/atlas-api-resourcePolicies.txt index a19914fbee..02cc4408d0 100644 --- a/docs/command/atlas-api-resourcePolicies.txt +++ b/docs/command/atlas-api-resourcePolicies.txt @@ -12,7 +12,7 @@ atlas api resourcePolicies :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Configure and manage Atlas Resource Policies within your organization.Configure and manage Atlas Resource Policies within your organization. +`Public Preview: please provide feedback `_: Configure and manage Atlas Resource Policies within your organization. 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. @@ -56,13 +56,13 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-resourcePolicies-createAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Create one Atlas Resource Policy for an org.Create one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-deleteAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Delete one Atlas Resource Policy for an org.Delete one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicies` - `Public Preview: please provide feedback `_: Return all Atlas Resource Policies for the org.Return all Atlas Resource Policies for the org. -* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Return one Atlas Resource Policy for an org.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.Return all non-compliant resources for an org. -* :ref:`atlas-api-resourcePolicies-updateAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Update one Atlas Resource Policy for an org.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.Validate one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-createAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Create one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-deleteAtlasResourcePolicy` - `Public Preview: please provide feedback `_: Delete one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicies` - `Public Preview: please provide feedback `_: Return all Atlas Resource Policies for the org. +* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicy` - `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-updateAtlasResourcePolicy` - `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. .. toctree:: diff --git a/docs/command/atlas-api-rollingIndex-createRollingIndex.txt b/docs/command/atlas-api-rollingIndex-createRollingIndex.txt index 75c1726c5a..e5783b89c0 100644 --- a/docs/command/atlas-api-rollingIndex-createRollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex-createRollingIndex.txt @@ -12,7 +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.Creates an index on the cluster identified by its name in a rolling manner. +`Public Preview: please provide feedback `_: Creates an index on the cluster identified by its name in a rolling manner. 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. diff --git a/docs/command/atlas-api-rollingIndex.txt b/docs/command/atlas-api-rollingIndex.txt index a86eebf697..1a581a5ba5 100644 --- a/docs/command/atlas-api-rollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex.txt @@ -12,7 +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.Creates one index to a database deployment in a rolling manner. +`Public Preview: please provide feedback `_: Creates one index to a database deployment in a rolling manner. 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. @@ -56,7 +56,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.Creates an index on the cluster identified by its name in a rolling manner. +* :ref:`atlas-api-rollingIndex-createRollingIndex` - `Public Preview: please provide feedback `_: 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 a21894e1b3..633e7bea22 100644 --- a/docs/command/atlas-api-root-getSystemStatus.txt +++ b/docs/command/atlas-api-root-getSystemStatus.txt @@ -12,7 +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.This resource returns information about the MongoDB application along with API key meta data. +`Public Preview: please provide feedback `_: This resource returns information about the MongoDB application along with API key meta data. 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. diff --git a/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt b/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt index 10a308c907..f328e8162a 100644 --- a/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt +++ b/docs/command/atlas-api-root-returnAllControlPlaneIpAddresses.txt @@ -12,7 +12,7 @@ atlas api root returnAllControlPlaneIpAddresses :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all control plane IP addresses.Returns all control plane IP addresses. +`Public Preview: please provide feedback `_: Returns all control plane IP addresses. 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. diff --git a/docs/command/atlas-api-root.txt b/docs/command/atlas-api-root.txt index 6cea237811..4c6c5b27f0 100644 --- a/docs/command/atlas-api-root.txt +++ b/docs/command/atlas-api-root.txt @@ -12,7 +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.Returns details that describe the MongoDB Cloud build and the access token that requests this resource. +`Public Preview: please provide feedback `_: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. 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. @@ -56,8 +56,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.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.Returns all control plane IP addresses. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt index 6f22a9495d..294259f98d 100644 --- a/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-createServerlessInstance.txt @@ -12,7 +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.Update as of Feb 2025: This endpoint now creates a Flex cluster instead. +`Public Preview: please provide feedback `_: Update as of Feb 2025: This endpoint now creates a Flex cluster instead. 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. diff --git a/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt index 9e526c85a3..9a5ebfa355 100644 --- a/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt @@ -12,7 +12,7 @@ atlas api serverlessInstances deleteServerlessInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one serverless instance from the specified project.Removes one serverless instance from the specified project. +`Public Preview: please provide feedback `_: Removes one serverless instance from the specified project. 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. diff --git a/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt index ed9d65f157..7b225f3693 100644 --- a/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt @@ -12,7 +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.Returns details for one serverless instance in the specified project. +`Public Preview: please provide feedback `_: Returns details for one serverless instance in the specified project. 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. diff --git a/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt b/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt index 886aa6e85a..a35b52ba7e 100644 --- a/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt +++ b/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt @@ -12,7 +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.Returns details for all serverless instances in the specified project. +`Public Preview: please provide feedback `_: Returns details for all serverless instances in the specified project. 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. diff --git a/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt index a8b48a60df..6669e0c417 100644 --- a/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt +++ b/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt @@ -12,7 +12,7 @@ atlas api serverlessInstances updateServerlessInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one serverless instance in the specified project.Updates one serverless instance in the specified project. +`Public Preview: please provide feedback `_: Updates one serverless instance in the specified project. 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. diff --git a/docs/command/atlas-api-serverlessInstances.txt b/docs/command/atlas-api-serverlessInstances.txt index ae0c71afc5..0acc578a01 100644 --- a/docs/command/atlas-api-serverlessInstances.txt +++ b/docs/command/atlas-api-serverlessInstances.txt @@ -12,7 +12,7 @@ atlas api serverlessInstances :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes serverless instances.Returns, adds, edits, and removes serverless instances. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes serverless instances. 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. @@ -56,11 +56,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.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.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.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.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.Updates one serverless instance in the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt index bb52897c9a..c55c90492f 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint.txt @@ -12,7 +12,7 @@ atlas api serverlessPrivateEndpoints createServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one private endpoint for one serverless instance.Creates one private endpoint for one serverless instance. +`Public Preview: please provide feedback `_: Creates one private endpoint for one serverless instance. 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. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt index a9a6c59574..68bb9d0e01 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt @@ -12,7 +12,7 @@ atlas api serverlessPrivateEndpoints deleteServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Remove one private endpoint from one serverless instance.Remove one private endpoint from one serverless instance. +`Public Preview: please provide feedback `_: Remove one private endpoint from one serverless instance. 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. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt index db302a3ef0..bbcf7477d8 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt @@ -12,7 +12,7 @@ atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Return one private endpoint for one serverless instance.Return one private endpoint for one serverless instance. +`Public Preview: please provide feedback `_: Return one private endpoint for one serverless instance. 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. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt index 24d95a14e0..174ad3357a 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt @@ -12,7 +12,7 @@ atlas api serverlessPrivateEndpoints listServerlessPrivateEndpoints :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all private endpoints for one serverless instance.Returns all private endpoints for one serverless instance. +`Public Preview: please provide feedback `_: Returns all private endpoints for one serverless instance. 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. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt index 3c2bbb661b..5ba1561184 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt @@ -12,7 +12,7 @@ atlas api serverlessPrivateEndpoints updateServerlessPrivateEndpoint :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one private endpoint for one serverless instance.Updates one private endpoint for one serverless instance. +`Public Preview: please provide feedback `_: Updates one private endpoint for one serverless instance. 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. diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints.txt b/docs/command/atlas-api-serverlessPrivateEndpoints.txt index d59f13fc21..d4eeba2c2e 100644 --- a/docs/command/atlas-api-serverlessPrivateEndpoints.txt +++ b/docs/command/atlas-api-serverlessPrivateEndpoints.txt @@ -12,7 +12,7 @@ atlas api serverlessPrivateEndpoints :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes private endpoints for serverless instances.Returns, adds, edits, and removes private endpoints for serverless instances. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes private endpoints for serverless instances. 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. @@ -56,11 +56,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint` - `Public Preview: please provide feedback `_: Creates one private endpoint for one serverless instance.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.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.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.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.Updates one private endpoint for one serverless instance. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt index 466659492f..1f0e5aedbd 100644 --- a/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-addProjectServiceAccount.txt @@ -12,7 +12,7 @@ atlas api serviceAccounts addProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Assigns the specified Service Account to the specified Project.Assigns the specified Service Account to the specified Project. +`Public Preview: please provide feedback `_: Assigns the specified Service Account to the specified Project. 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. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt index bc43cdc552..bfceb7941e 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccount.txt @@ -12,7 +12,7 @@ atlas api serviceAccounts createProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one Service Account for the specified Project.Creates one Service Account for the specified Project. +`Public Preview: please provide feedback `_: Creates one Service Account for the specified Project. 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. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt index a29568a74e..646c014a26 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt @@ -12,7 +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.Add Access List Entries for the specified Service Account for the project. +`Public Preview: please provide feedback `_: Add Access List Entries for the specified Service Account for the project. 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. diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt index b6a78b1fb1..be806d1950 100644 --- a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt @@ -12,7 +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.Create a secret for the specified Service Account in the specified Project. +`Public Preview: please provide feedback `_: Create a secret for the specified Service Account in the specified Project. 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. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt index 6c6690bc90..f6db7b32f7 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccount.txt @@ -12,7 +12,7 @@ atlas api serviceAccounts createServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one Service Account for the specified Organization.Creates one Service Account for the specified Organization. +`Public Preview: please provide feedback `_: Creates one Service Account for the specified Organization. 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. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt index 974151ee3a..2201aafa19 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccountAccessList.txt @@ -12,7 +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.Add Access List Entries for the specified Service Account for the organization. +`Public Preview: please provide feedback `_: Add Access List Entries for the specified Service Account for the organization. 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. diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt index 4fbb4448e2..31cf2fd0a1 100644 --- a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt @@ -12,7 +12,7 @@ atlas api serviceAccounts createServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Create a secret for the specified Service Account.Create a secret for the specified Service Account. +`Public Preview: please provide feedback `_: Create a secret for the specified Service Account. 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. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt index 51e07b3090..c081cb8efb 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccount.txt @@ -12,7 +12,7 @@ atlas api serviceAccounts deleteProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes the specified Service Account from the specified project.Removes the specified Service Account from the specified project. +`Public Preview: please provide feedback `_: Removes the specified Service Account from the specified project. 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. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt index 28fa0b109e..32234dad7f 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt @@ -12,7 +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.Removes the specified access list entry from the specified Service Account for the project. +`Public Preview: please provide feedback `_: Removes the specified access list entry from the specified Service Account for the project. 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. diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt index b9bfabce39..ece1ea74b1 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt @@ -12,7 +12,7 @@ atlas api serviceAccounts deleteProjectServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes the specified Service Account secret.Deletes the specified Service Account secret. +`Public Preview: please provide feedback `_: Deletes the specified Service Account secret. 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. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt index 0dd00fc3e1..640f1ede7a 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccount.txt @@ -12,7 +12,7 @@ atlas api serviceAccounts deleteServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes the specified Service Account.Deletes the specified Service Account. +`Public Preview: please provide feedback `_: Deletes the specified Service Account. 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. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt index 6a332bef88..086992af84 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry.txt @@ -12,7 +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.Removes the specified access list entry from the specified Service Account for the organization. +`Public Preview: please provide feedback `_: Removes the specified access list entry from the specified Service Account for the organization. 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. diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt index 28874e6ca7..f677b04750 100644 --- a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt +++ b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt @@ -12,7 +12,7 @@ atlas api serviceAccounts deleteServiceAccountSecret :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes the specified Service Account secret.Deletes the specified Service Account secret. +`Public Preview: please provide feedback `_: Deletes the specified Service Account secret. 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. diff --git a/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt index 9bde7542ff..3e43642cb6 100644 --- a/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-getProjectServiceAccount.txt @@ -12,7 +12,7 @@ atlas api serviceAccounts getProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns one Service Account in the specified Project.Returns one Service Account in the specified Project. +`Public Preview: please provide feedback `_: Returns one Service Account in the specified Project. 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. diff --git a/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt index d738b03e16..426b64328c 100644 --- a/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-getServiceAccount.txt @@ -12,7 +12,7 @@ atlas api serviceAccounts getServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns the specified Service Account.Returns the specified Service Account. +`Public Preview: please provide feedback `_: Returns the specified Service Account. 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. diff --git a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt index d2aba8892a..acfd085808 100644 --- a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccountAccessList.txt @@ -12,7 +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.Returns all access list entries that you configured for the specified Service Account for the project. +`Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified Service Account for the project. 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. diff --git a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt index d35d8f71ae..f1cb787d9d 100644 --- a/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts-listProjectServiceAccounts.txt @@ -12,7 +12,7 @@ atlas api serviceAccounts listProjectServiceAccounts :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all Service Accounts for the specified Project.Returns all Service Accounts for the specified Project. +`Public Preview: please provide feedback `_: Returns all Service Accounts for the specified Project. 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. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt index 746ca07e74..12a422d1f5 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccountAccessList.txt @@ -12,7 +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.Returns all access list entries that you configured for the specified Service Account for the organization. +`Public Preview: please provide feedback `_: Returns all access list entries that you configured for the specified Service Account for the organization. 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. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt index b7ab5a64df..77ba465a41 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccountProjects.txt @@ -12,7 +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.Returns a list of all projects the specified Service Account is a part of. +`Public Preview: please provide feedback `_: Returns a list of all projects the specified Service Account is a part of. 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. diff --git a/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt b/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt index a6bdefdca4..26a540dff6 100644 --- a/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts-listServiceAccounts.txt @@ -12,7 +12,7 @@ atlas api serviceAccounts listServiceAccounts :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all Service Accounts for the specified Organization.Returns all Service Accounts for the specified Organization. +`Public Preview: please provide feedback `_: Returns all Service Accounts for the specified Organization. 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. diff --git a/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt index 7e5ea806c2..1dbdd27072 100644 --- a/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-updateProjectServiceAccount.txt @@ -12,7 +12,7 @@ atlas api serviceAccounts updateProjectServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates one Service Account in the specified Project.Updates one Service Account in the specified Project. +`Public Preview: please provide feedback `_: Updates one Service Account in the specified Project. 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. diff --git a/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt b/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt index 9b7c583f50..0e62de1423 100644 --- a/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt +++ b/docs/command/atlas-api-serviceAccounts-updateServiceAccount.txt @@ -12,7 +12,7 @@ atlas api serviceAccounts updateServiceAccount :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the specified Service Account in the specified Organization.Updates the specified Service Account in the specified Organization. +`Public Preview: please provide feedback `_: Updates the specified Service Account in the specified Organization. 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. diff --git a/docs/command/atlas-api-serviceAccounts.txt b/docs/command/atlas-api-serviceAccounts.txt index c8259f2539..096b1c2053 100644 --- a/docs/command/atlas-api-serviceAccounts.txt +++ b/docs/command/atlas-api-serviceAccounts.txt @@ -12,7 +12,7 @@ atlas api serviceAccounts :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Endpoints for managing Service Accounts and secrets.Endpoints for managing Service Accounts and secrets. +`Public Preview: please provide feedback `_: Endpoints for managing Service Accounts and secrets. 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. @@ -56,28 +56,28 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serviceAccounts-addProjectServiceAccount` - `Public Preview: please provide feedback `_: Assigns the specified Service Account to the specified Project.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.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.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.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.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.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.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.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.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.Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccount` - `Public Preview: please provide feedback `_: Deletes the specified Service Account.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.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.Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-getProjectServiceAccount` - `Public Preview: please provide feedback `_: Returns one Service Account in the specified Project.Returns one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-getServiceAccount` - `Public Preview: please provide feedback `_: Returns the specified Service Account.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.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.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.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.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.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.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.Updates the specified Service Account in the specified Organization. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt b/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt index ff980f5753..6862471965 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob.txt @@ -12,7 +12,7 @@ atlas api sharedTierRestoreJobs createSharedClusterBackupRestoreJob :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Restores the specified M2 or M5 cluster.Restores the specified M2 or M5 cluster. +`Public Preview: please provide feedback `_: Restores the specified M2 or M5 cluster. 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. diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt b/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt index 1caa2c4f14..8098fc99e0 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt @@ -12,7 +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.Returns the specified restore job for the specified M2 or M5 cluster. +`Public Preview: please provide feedback `_: Returns the specified restore job for the specified M2 or M5 cluster. 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. diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt b/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt index b52e443069..8e87872150 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt @@ -12,7 +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.Returns all restore jobs for the specified M2 or M5 cluster. +`Public Preview: please provide feedback `_: Returns all restore jobs for the specified M2 or M5 cluster. 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. diff --git a/docs/command/atlas-api-sharedTierRestoreJobs.txt b/docs/command/atlas-api-sharedTierRestoreJobs.txt index 3142bb896c..415f404b52 100644 --- a/docs/command/atlas-api-sharedTierRestoreJobs.txt +++ b/docs/command/atlas-api-sharedTierRestoreJobs.txt @@ -12,7 +12,7 @@ atlas api sharedTierRestoreJobs :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns and adds restore jobs for shared-tier database deployments.Returns and adds restore jobs for shared-tier database deployments. +`Public Preview: please provide feedback `_: Returns and adds restore jobs for shared-tier database deployments. 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. @@ -56,9 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob` - `Public Preview: please provide feedback `_: Restores the specified M2 or M5 cluster.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.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.Returns all restore jobs for the specified M2 or M5 cluster. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt b/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt index 92ebaea167..7bb3e380f7 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-downloadSharedClusterBackup.txt @@ -12,7 +12,7 @@ atlas api sharedTierSnapshots downloadSharedClusterBackup :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Requests one snapshot for the specified shared cluster.Requests one snapshot for the specified shared cluster. +`Public Preview: please provide feedback `_: Requests one snapshot for the specified shared cluster. 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. diff --git a/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt b/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt index 8c2c8c86b7..fc3a0159c8 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt @@ -12,7 +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.Returns details for one snapshot for the specified shared cluster. +`Public Preview: please provide feedback `_: Returns details for one snapshot for the specified shared cluster. 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. diff --git a/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt b/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt index 964dcb9c9d..390bbf1671 100644 --- a/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt +++ b/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt @@ -12,7 +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.Returns details for all snapshots for the specified shared cluster. +`Public Preview: please provide feedback `_: Returns details for all snapshots for the specified shared cluster. 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. diff --git a/docs/command/atlas-api-sharedTierSnapshots.txt b/docs/command/atlas-api-sharedTierSnapshots.txt index 707d561618..ca50d27fac 100644 --- a/docs/command/atlas-api-sharedTierSnapshots.txt +++ b/docs/command/atlas-api-sharedTierSnapshots.txt @@ -12,7 +12,7 @@ atlas api sharedTierSnapshots :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns and requests to download shared-tier database deployment snapshots.Returns and requests to download shared-tier database deployment snapshots. +`Public Preview: please provide feedback `_: Returns and requests to download shared-tier database deployment snapshots. 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. @@ -56,9 +56,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierSnapshots-downloadSharedClusterBackup` - `Public Preview: please provide feedback `_: Requests one snapshot for the specified shared cluster.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.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.Returns details for all snapshots for the specified shared cluster. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt b/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt index 2c592581f2..6d39156ab8 100644 --- a/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-acceptVpcPeeringConnection.txt @@ -12,7 +12,7 @@ atlas api streams acceptVpcPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Requests the acceptance of an incoming VPC Peering connection.Requests the acceptance of an incoming VPC Peering connection. +`Public Preview: please provide feedback `_: Requests the acceptance of an incoming VPC Peering connection. 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. diff --git a/docs/command/atlas-api-streams-createPrivateLinkConnection.txt b/docs/command/atlas-api-streams-createPrivateLinkConnection.txt index 56fae7192f..b2571549c5 100644 --- a/docs/command/atlas-api-streams-createPrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-createPrivateLinkConnection.txt @@ -12,7 +12,7 @@ atlas api streams createPrivateLinkConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one Private Link in the specified project.Creates one Private Link in the specified project. +`Public Preview: please provide feedback `_: Creates one Private Link in the specified project. 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. diff --git a/docs/command/atlas-api-streams-createStreamConnection.txt b/docs/command/atlas-api-streams-createStreamConnection.txt index 56bd5616ac..d9bbed8615 100644 --- a/docs/command/atlas-api-streams-createStreamConnection.txt +++ b/docs/command/atlas-api-streams-createStreamConnection.txt @@ -12,7 +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.Creates one connection for a stream instance in the specified project. +`Public Preview: please provide feedback `_: Creates one connection for a stream instance in the specified project. 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. diff --git a/docs/command/atlas-api-streams-createStreamInstance.txt b/docs/command/atlas-api-streams-createStreamInstance.txt index ce51275050..59bb82efed 100644 --- a/docs/command/atlas-api-streams-createStreamInstance.txt +++ b/docs/command/atlas-api-streams-createStreamInstance.txt @@ -12,7 +12,7 @@ atlas api streams createStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one stream instance in the specified project.Creates one stream instance in the specified project. +`Public Preview: please provide feedback `_: Creates one stream instance in the specified project. 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. diff --git a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt b/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt index 05cf62cafe..0e63dc307c 100644 --- a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt +++ b/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt @@ -12,7 +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.Creates one stream instance in the specified project with sample connections. +`Public Preview: please provide feedback `_: Creates one stream instance in the specified project with sample connections. 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. diff --git a/docs/command/atlas-api-streams-createStreamProcessor.txt b/docs/command/atlas-api-streams-createStreamProcessor.txt index a2752f2e7e..a280e38946 100644 --- a/docs/command/atlas-api-streams-createStreamProcessor.txt +++ b/docs/command/atlas-api-streams-createStreamProcessor.txt @@ -12,7 +12,7 @@ atlas api streams createStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Create one Stream Processor within the specified stream instance.Create one Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: Create one Stream Processor within the specified stream instance. 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. diff --git a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt index 78b92ce35b..823c771942 100644 --- a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt @@ -12,7 +12,7 @@ atlas api streams deletePrivateLinkConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes one Private Link in the specified project.Deletes one Private Link in the specified project. +`Public Preview: please provide feedback `_: Deletes one Private Link in the specified project. 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. diff --git a/docs/command/atlas-api-streams-deleteStreamConnection.txt b/docs/command/atlas-api-streams-deleteStreamConnection.txt index cf7fc49e53..122567f201 100644 --- a/docs/command/atlas-api-streams-deleteStreamConnection.txt +++ b/docs/command/atlas-api-streams-deleteStreamConnection.txt @@ -12,7 +12,7 @@ atlas api streams deleteStreamConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Delete one connection of the specified stream instance.Delete one connection of the specified stream instance. +`Public Preview: please provide feedback `_: Delete one connection of the specified stream instance. 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. diff --git a/docs/command/atlas-api-streams-deleteStreamInstance.txt b/docs/command/atlas-api-streams-deleteStreamInstance.txt index c7ee48dbdd..bef646f2fd 100644 --- a/docs/command/atlas-api-streams-deleteStreamInstance.txt +++ b/docs/command/atlas-api-streams-deleteStreamInstance.txt @@ -12,7 +12,7 @@ atlas api streams deleteStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Delete one stream instance in the specified project.Delete one stream instance in the specified project. +`Public Preview: please provide feedback `_: Delete one stream instance in the specified project. 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. diff --git a/docs/command/atlas-api-streams-deleteStreamProcessor.txt b/docs/command/atlas-api-streams-deleteStreamProcessor.txt index 08154b3c17..9bb76318bf 100644 --- a/docs/command/atlas-api-streams-deleteStreamProcessor.txt +++ b/docs/command/atlas-api-streams-deleteStreamProcessor.txt @@ -12,7 +12,7 @@ atlas api streams deleteStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Delete a Stream Processor within the specified stream instance.Delete a Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: Delete a Stream Processor within the specified stream instance. 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. diff --git a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt index 7c7e560177..2a5ecd75f5 100644 --- a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt @@ -12,7 +12,7 @@ atlas api streams deleteVpcPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Deletes an incoming VPC Peering connection.Deletes an incoming VPC Peering connection. +`Public Preview: please provide feedback `_: Deletes an incoming VPC Peering connection. 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. diff --git a/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt b/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt index 58486e4f9f..56839a16e3 100644 --- a/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt +++ b/docs/command/atlas-api-streams-downloadStreamTenantAuditLogs.txt @@ -12,7 +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.Downloads the audit logs for the specified Atlas Streams Processing instance. +`Public Preview: please provide feedback `_: Downloads the audit logs for the specified Atlas Streams Processing instance. 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. diff --git a/docs/command/atlas-api-streams-getAccountDetails.txt b/docs/command/atlas-api-streams-getAccountDetails.txt index d80fd71598..44a7c3b2be 100644 --- a/docs/command/atlas-api-streams-getAccountDetails.txt +++ b/docs/command/atlas-api-streams-getAccountDetails.txt @@ -12,7 +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.Returns the Account ID, and the VPC ID for the group and region specified. +`Public Preview: please provide feedback `_: Returns the Account ID, and the VPC ID for the group and region specified. 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. diff --git a/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt index b401144b48..a2f7912527 100644 --- a/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt +++ b/docs/command/atlas-api-streams-getActiveVpcPeeringConnections.txt @@ -12,7 +12,7 @@ atlas api streams getActiveVpcPeeringConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns a list of active incoming VPC Peering Connections.Returns a list of active incoming VPC Peering Connections. +`Public Preview: please provide feedback `_: Returns a list of active incoming VPC Peering Connections. 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. diff --git a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt index 17bedc988a..8d596d6e57 100644 --- a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt +++ b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt @@ -12,7 +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.Returns the details of one Private Link connection within the project. +`Public Preview: please provide feedback `_: Returns the details of one Private Link connection within the project. 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. diff --git a/docs/command/atlas-api-streams-getStreamConnection.txt b/docs/command/atlas-api-streams-getStreamConnection.txt index 9f5a85d85c..30c844fef7 100644 --- a/docs/command/atlas-api-streams-getStreamConnection.txt +++ b/docs/command/atlas-api-streams-getStreamConnection.txt @@ -12,7 +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.Returns the details of one stream connection within the specified stream instance. +`Public Preview: please provide feedback `_: Returns the details of one stream connection within the specified stream instance. 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. diff --git a/docs/command/atlas-api-streams-getStreamInstance.txt b/docs/command/atlas-api-streams-getStreamInstance.txt index e444bf937b..d4fda560a3 100644 --- a/docs/command/atlas-api-streams-getStreamInstance.txt +++ b/docs/command/atlas-api-streams-getStreamInstance.txt @@ -12,7 +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.Returns the details of one stream instance within the specified project. +`Public Preview: please provide feedback `_: Returns the details of one stream instance within the specified project. 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. diff --git a/docs/command/atlas-api-streams-getStreamProcessor.txt b/docs/command/atlas-api-streams-getStreamProcessor.txt index 3131272758..e942f22fd2 100644 --- a/docs/command/atlas-api-streams-getStreamProcessor.txt +++ b/docs/command/atlas-api-streams-getStreamProcessor.txt @@ -12,7 +12,7 @@ atlas api streams getStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Get one Stream Processor within the specified stream instance.Get one Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: Get one Stream Processor within the specified stream instance. 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. diff --git a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getVpcPeeringConnections.txt index 6ef7494fdc..8253cf824b 100644 --- a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt +++ b/docs/command/atlas-api-streams-getVpcPeeringConnections.txt @@ -12,7 +12,7 @@ atlas api streams getVpcPeeringConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns a list of incoming VPC Peering Connections.Returns a list of incoming VPC Peering Connections. +`Public Preview: please provide feedback `_: Returns a list of incoming VPC Peering Connections. 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. diff --git a/docs/command/atlas-api-streams-listPrivateLinkConnections.txt b/docs/command/atlas-api-streams-listPrivateLinkConnections.txt index 6a0441ee85..2e4052642b 100644 --- a/docs/command/atlas-api-streams-listPrivateLinkConnections.txt +++ b/docs/command/atlas-api-streams-listPrivateLinkConnections.txt @@ -12,7 +12,7 @@ atlas api streams listPrivateLinkConnections :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all Private Link connections for the specified project.Returns all Private Link connections for the specified project. +`Public Preview: please provide feedback `_: Returns all Private Link connections for the specified project. 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. diff --git a/docs/command/atlas-api-streams-listStreamConnections.txt b/docs/command/atlas-api-streams-listStreamConnections.txt index a90b1a0188..906035e3df 100644 --- a/docs/command/atlas-api-streams-listStreamConnections.txt +++ b/docs/command/atlas-api-streams-listStreamConnections.txt @@ -12,7 +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.Returns all connections of the stream instance for the specified project. +`Public Preview: please provide feedback `_: Returns all connections of the stream instance for the specified project. 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. diff --git a/docs/command/atlas-api-streams-listStreamInstances.txt b/docs/command/atlas-api-streams-listStreamInstances.txt index bb25fa4b19..6ffd4b530f 100644 --- a/docs/command/atlas-api-streams-listStreamInstances.txt +++ b/docs/command/atlas-api-streams-listStreamInstances.txt @@ -12,7 +12,7 @@ atlas api streams listStreamInstances :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all stream instances for the specified project.Returns all stream instances for the specified project. +`Public Preview: please provide feedback `_: Returns all stream instances for the specified project. 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. diff --git a/docs/command/atlas-api-streams-listStreamProcessors.txt b/docs/command/atlas-api-streams-listStreamProcessors.txt index cfca48ffc9..048a724032 100644 --- a/docs/command/atlas-api-streams-listStreamProcessors.txt +++ b/docs/command/atlas-api-streams-listStreamProcessors.txt @@ -12,7 +12,7 @@ atlas api streams listStreamProcessors :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all Stream Processors within the specified stream instance.Returns all Stream Processors within the specified stream instance. +`Public Preview: please provide feedback `_: Returns all Stream Processors within the specified stream instance. 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. diff --git a/docs/command/atlas-api-streams-modifyStreamProcessor.txt b/docs/command/atlas-api-streams-modifyStreamProcessor.txt index d1970567f7..60e61de362 100644 --- a/docs/command/atlas-api-streams-modifyStreamProcessor.txt +++ b/docs/command/atlas-api-streams-modifyStreamProcessor.txt @@ -12,7 +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.Modify one existing Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: Modify one existing Stream Processor within the specified stream instance. 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. diff --git a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt index 63eea30e2c..6add535e4f 100644 --- a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt +++ b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt @@ -12,7 +12,7 @@ atlas api streams rejectVpcPeeringConnection :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Requests the rejection of an incoming VPC Peering connection.Requests the rejection of an incoming VPC Peering connection. +`Public Preview: please provide feedback `_: Requests the rejection of an incoming VPC Peering connection. 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. diff --git a/docs/command/atlas-api-streams-startStreamProcessor.txt b/docs/command/atlas-api-streams-startStreamProcessor.txt index db8a784257..f21c594795 100644 --- a/docs/command/atlas-api-streams-startStreamProcessor.txt +++ b/docs/command/atlas-api-streams-startStreamProcessor.txt @@ -12,7 +12,7 @@ atlas api streams startStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Start a Stream Processor within the specified stream instance.Start a Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: Start a Stream Processor within the specified stream instance. 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. diff --git a/docs/command/atlas-api-streams-startStreamProcessorWith.txt b/docs/command/atlas-api-streams-startStreamProcessorWith.txt index 461949583c..c42b0bd8d6 100644 --- a/docs/command/atlas-api-streams-startStreamProcessorWith.txt +++ b/docs/command/atlas-api-streams-startStreamProcessorWith.txt @@ -12,7 +12,7 @@ atlas api streams startStreamProcessorWith :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Start a Stream Processor within the specified stream instance.Start a Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: Start a Stream Processor within the specified stream instance. 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. diff --git a/docs/command/atlas-api-streams-stopStreamProcessor.txt b/docs/command/atlas-api-streams-stopStreamProcessor.txt index 89fde8120f..1e7f84d19f 100644 --- a/docs/command/atlas-api-streams-stopStreamProcessor.txt +++ b/docs/command/atlas-api-streams-stopStreamProcessor.txt @@ -12,7 +12,7 @@ atlas api streams stopStreamProcessor :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Stop a Stream Processor within the specified stream instance.Stop a Stream Processor within the specified stream instance. +`Public Preview: please provide feedback `_: Stop a Stream Processor within the specified stream instance. 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. diff --git a/docs/command/atlas-api-streams-updateStreamConnection.txt b/docs/command/atlas-api-streams-updateStreamConnection.txt index fa7a9386cb..d727f29d56 100644 --- a/docs/command/atlas-api-streams-updateStreamConnection.txt +++ b/docs/command/atlas-api-streams-updateStreamConnection.txt @@ -12,7 +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.Update one connection for the specified stream instance in the specified project. +`Public Preview: please provide feedback `_: Update one connection for the specified stream instance in the specified project. 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. diff --git a/docs/command/atlas-api-streams-updateStreamInstance.txt b/docs/command/atlas-api-streams-updateStreamInstance.txt index 92114dfa55..831b882a73 100644 --- a/docs/command/atlas-api-streams-updateStreamInstance.txt +++ b/docs/command/atlas-api-streams-updateStreamInstance.txt @@ -12,7 +12,7 @@ atlas api streams updateStreamInstance :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Update one stream instance in the specified project.Update one stream instance in the specified project. +`Public Preview: please provide feedback `_: Update one stream instance in the specified project. 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. diff --git a/docs/command/atlas-api-streams.txt b/docs/command/atlas-api-streams.txt index d99c0742a8..34375e7407 100644 --- a/docs/command/atlas-api-streams.txt +++ b/docs/command/atlas-api-streams.txt @@ -12,7 +12,7 @@ atlas api streams :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes Streams Instances.Returns, adds, edits, and removes Streams Instances. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes Streams Instances. 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. @@ -56,36 +56,36 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-streams-acceptVpcPeeringConnection` - `Public Preview: please provide feedback `_: Requests the acceptance of an incoming VPC Peering connection.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.Update one stream instance in the specified project. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-teams-addAllTeamsToProject.txt b/docs/command/atlas-api-teams-addAllTeamsToProject.txt index 8ea471065d..48f37080ac 100644 --- a/docs/command/atlas-api-teams-addAllTeamsToProject.txt +++ b/docs/command/atlas-api-teams-addAllTeamsToProject.txt @@ -12,7 +12,7 @@ atlas api teams addAllTeamsToProject :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Adds one or more teams to the specified project.Adds one or more teams to the specified project. +`Public Preview: please provide feedback `_: Adds one or more teams to the specified project. 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. diff --git a/docs/command/atlas-api-teams-addTeamUser.txt b/docs/command/atlas-api-teams-addTeamUser.txt index d1a7fb38c3..ba4ebf6291 100644 --- a/docs/command/atlas-api-teams-addTeamUser.txt +++ b/docs/command/atlas-api-teams-addTeamUser.txt @@ -12,7 +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.Adds one or more MongoDB Cloud users from the specified organization to the specified team. +`Public Preview: please provide feedback `_: Adds one or more MongoDB Cloud users from the specified organization to the specified team. 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. diff --git a/docs/command/atlas-api-teams-createTeam.txt b/docs/command/atlas-api-teams-createTeam.txt index 55a8117b6e..06c03a3832 100644 --- a/docs/command/atlas-api-teams-createTeam.txt +++ b/docs/command/atlas-api-teams-createTeam.txt @@ -12,7 +12,7 @@ atlas api teams createTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Creates one team in the specified organization.Creates one team in the specified organization. +`Public Preview: please provide feedback `_: Creates one team in the specified organization. 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. diff --git a/docs/command/atlas-api-teams-deleteTeam.txt b/docs/command/atlas-api-teams-deleteTeam.txt index 319029e77f..0656979460 100644 --- a/docs/command/atlas-api-teams-deleteTeam.txt +++ b/docs/command/atlas-api-teams-deleteTeam.txt @@ -12,7 +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.Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. +`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. 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. diff --git a/docs/command/atlas-api-teams-getTeamById.txt b/docs/command/atlas-api-teams-getTeamById.txt index ae731aef97..b25674370e 100644 --- a/docs/command/atlas-api-teams-getTeamById.txt +++ b/docs/command/atlas-api-teams-getTeamById.txt @@ -12,7 +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.Returns one team that you identified using its unique 24-hexadecimal digit ID. +`Public Preview: please provide feedback `_: Returns one team that you identified using its unique 24-hexadecimal digit ID. 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. diff --git a/docs/command/atlas-api-teams-getTeamByName.txt b/docs/command/atlas-api-teams-getTeamByName.txt index 6383aaaac6..46fdd67e9c 100644 --- a/docs/command/atlas-api-teams-getTeamByName.txt +++ b/docs/command/atlas-api-teams-getTeamByName.txt @@ -12,7 +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.Returns one team that you identified using its human-readable name. +`Public Preview: please provide feedback `_: Returns one team that you identified using its human-readable name. 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. diff --git a/docs/command/atlas-api-teams-listOrganizationTeams.txt b/docs/command/atlas-api-teams-listOrganizationTeams.txt index 67d6514991..57481f4128 100644 --- a/docs/command/atlas-api-teams-listOrganizationTeams.txt +++ b/docs/command/atlas-api-teams-listOrganizationTeams.txt @@ -12,7 +12,7 @@ atlas api teams listOrganizationTeams :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns all teams that belong to the specified organization.Returns all teams that belong to the specified organization. +`Public Preview: please provide feedback `_: Returns all teams that belong to the specified organization. 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. diff --git a/docs/command/atlas-api-teams-listProjectTeams.txt b/docs/command/atlas-api-teams-listProjectTeams.txt index a13f36f225..a25be5eaae 100644 --- a/docs/command/atlas-api-teams-listProjectTeams.txt +++ b/docs/command/atlas-api-teams-listProjectTeams.txt @@ -12,7 +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.Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. +`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. 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. diff --git a/docs/command/atlas-api-teams-removeProjectTeam.txt b/docs/command/atlas-api-teams-removeProjectTeam.txt index 5d4c8ebdec..7f469b5b7f 100644 --- a/docs/command/atlas-api-teams-removeProjectTeam.txt +++ b/docs/command/atlas-api-teams-removeProjectTeam.txt @@ -12,7 +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.Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. +`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. 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. diff --git a/docs/command/atlas-api-teams-removeTeamUser.txt b/docs/command/atlas-api-teams-removeTeamUser.txt index d544dcb889..a102ed7dd8 100644 --- a/docs/command/atlas-api-teams-removeTeamUser.txt +++ b/docs/command/atlas-api-teams-removeTeamUser.txt @@ -12,7 +12,7 @@ atlas api teams removeTeamUser :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from the specified team.Removes one MongoDB Cloud user from the specified team. +`Public Preview: please provide feedback `_: Removes one MongoDB Cloud user from the specified team. 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. diff --git a/docs/command/atlas-api-teams-renameTeam.txt b/docs/command/atlas-api-teams-renameTeam.txt index 17852dec3b..6f05792a34 100644 --- a/docs/command/atlas-api-teams-renameTeam.txt +++ b/docs/command/atlas-api-teams-renameTeam.txt @@ -12,7 +12,7 @@ atlas api teams renameTeam :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Renames one team in the specified organization.Renames one team in the specified organization. +`Public Preview: please provide feedback `_: Renames one team in the specified organization. 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. diff --git a/docs/command/atlas-api-teams-updateTeamRoles.txt b/docs/command/atlas-api-teams-updateTeamRoles.txt index d1f2fed5b2..f89164856b 100644 --- a/docs/command/atlas-api-teams-updateTeamRoles.txt +++ b/docs/command/atlas-api-teams-updateTeamRoles.txt @@ -12,7 +12,7 @@ atlas api teams updateTeamRoles :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Updates the project roles assigned to the specified team.Updates the project roles assigned to the specified team. +`Public Preview: please provide feedback `_: Updates the project roles assigned to the specified team. 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. diff --git a/docs/command/atlas-api-teams.txt b/docs/command/atlas-api-teams.txt index d1b8b81186..8a585a0316 100644 --- a/docs/command/atlas-api-teams.txt +++ b/docs/command/atlas-api-teams.txt @@ -12,7 +12,7 @@ atlas api teams :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, or removes teams.Returns, adds, edits, or removes teams. +`Public Preview: please provide feedback `_: Returns, adds, edits, or removes teams. 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. @@ -56,18 +56,18 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-teams-addAllTeamsToProject` - `Public Preview: please provide feedback `_: Adds one or more teams to the specified project.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.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.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.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-getTeamById` - `Public Preview: please provide feedback `_: Returns one team that you identified using its unique 24-hexadecimal digit ID.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.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.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.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.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.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.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.Updates the project roles assigned to the specified team. +* :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-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. .. toctree:: diff --git a/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt index f68fbb919a..5e7f3e0fc9 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt @@ -12,7 +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.Adds the settings for configuring one third-party service integration. +`Public Preview: please provide feedback `_: Adds the settings for configuring one third-party service integration. 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. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt index 89b7265015..9247c173ca 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt @@ -12,7 +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.Removes the settings that permit configuring one third-party service integration. +`Public Preview: please provide feedback `_: Removes the settings that permit configuring one third-party service integration. 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. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt index f344afe688..e3aa2ddde3 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt @@ -12,7 +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.Returns the settings for configuring integration with one third-party service. +`Public Preview: please provide feedback `_: Returns the settings for configuring integration with one third-party service. 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. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt index a013722401..74d23b2c2e 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt @@ -12,7 +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.Returns the settings that permit integrations with all configured third-party services. +`Public Preview: please provide feedback `_: Returns the settings that permit integrations with all configured third-party services. 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. diff --git a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt index d257ddaae0..9c02c456ed 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt @@ -12,7 +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.Updates the settings for configuring integration with one third-party service. +`Public Preview: please provide feedback `_: Updates the settings for configuring integration with one third-party service. 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. diff --git a/docs/command/atlas-api-thirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations.txt index 2d893e7b8a..64054ce4ff 100644 --- a/docs/command/atlas-api-thirdPartyIntegrations.txt +++ b/docs/command/atlas-api-thirdPartyIntegrations.txt @@ -12,7 +12,7 @@ atlas api thirdPartyIntegrations :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, adds, edits, and removes third-party service integration configurations.Returns, adds, edits, and removes third-party service integration configurations. +`Public Preview: please provide feedback `_: Returns, adds, edits, and removes third-party service integration configurations. 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. @@ -59,11 +59,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.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.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.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.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.Updates the settings for configuring integration with one third-party service. +* :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. .. toctree:: diff --git a/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt b/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt index 17c2b44ac7..2b63ddb49d 100644 --- a/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt +++ b/docs/command/atlas-api-x509Authentication-createDatabaseUserCertificate.txt @@ -12,7 +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.Generates one X.509 certificate for the specified MongoDB user. +`Public Preview: please provide feedback `_: Generates one X.509 certificate for the specified MongoDB user. 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. diff --git a/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt b/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt index 5ddb566ca2..b533aa5ed2 100644 --- a/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt +++ b/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt @@ -12,7 +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.Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. +`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. 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. diff --git a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt b/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt index bf9be268a1..152547af45 100644 --- a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt +++ b/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt @@ -12,7 +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.Returns all unexpired X.509 certificates for the specified MongoDB user. +`Public Preview: please provide feedback `_: Returns all unexpired X.509 certificates for the specified MongoDB user. 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. diff --git a/docs/command/atlas-api-x509Authentication.txt b/docs/command/atlas-api-x509Authentication.txt index fc03634f39..5df3c92d4f 100644 --- a/docs/command/atlas-api-x509Authentication.txt +++ b/docs/command/atlas-api-x509Authentication.txt @@ -12,7 +12,7 @@ atlas api x509Authentication :depth: 1 :class: singlecol -`Public Preview: please provide feedback `_: Returns, edits, and removes user-managed X.509 configurations.Returns, edits, and removes user-managed X.509 configurations. +`Public Preview: please provide feedback `_: Returns, edits, and removes user-managed X.509 configurations. 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. @@ -56,9 +56,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.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.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.Returns all unexpired X.509 certificates for the specified MongoDB user. +* :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. .. toctree:: diff --git a/docs/command/atlas-api.txt b/docs/command/atlas-api.txt index c42e308dfa..cab509244e 100644 --- a/docs/command/atlas-api.txt +++ b/docs/command/atlas-api.txt @@ -12,7 +12,7 @@ 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 '. +`Public Preview: please provide feedback `_: Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api '. 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. @@ -179,56 +179,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.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.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.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.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.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.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.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.Manages the Cloud Migration Service. -* :ref:`atlas-api-cloudProviderAccess` - `Public Preview: please provide feedback `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas.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.Returns, starts, or ends a cluster outage simulation. -* :ref:`atlas-api-clusters` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes database deployments.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.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.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.Returns, adds, edits, and removes Federated Database Instances. -* :ref:`atlas-api-dataLakePipelines` - `Public Preview: please provide feedback `_: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs.Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. -* :ref:`atlas-api-databaseUsers` - `Public Preview: please provide feedback `_: Returns, adds, edits, and removes database users.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.Returns and edits the Encryption at Rest using Customer Key Management configuration. -* :ref:`atlas-api-events` - `Public Preview: please provide feedback `_: Returns events.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.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.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.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.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.Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. -* :ref:`atlas-api-invoices` - `Public Preview: please provide feedback `_: Returns invoices.Returns invoices. -* :ref:`atlas-api-ldapConfiguration` - `Public Preview: please provide feedback `_: Returns, edits, verifies, and removes LDAP configurations.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.Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. -* :ref:`atlas-api-maintenanceWindows` - `Public Preview: please provide feedback `_: Returns, edits, and removes maintenance windows.Returns, edits, and removes maintenance windows. -* :ref:`atlas-api-mongoDbCloudUsers` - `Public Preview: please provide feedback `_: Returns, adds, and edits MongoDB Cloud users.Returns, adds, and edits MongoDB Cloud users. -* :ref:`atlas-api-monitoringAndLogs` - `Public Preview: please provide feedback `_: Returns database deployment monitoring and logging data.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.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.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.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.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.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.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.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.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.You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. -* :ref:`atlas-api-resourcePolicies` - `Public Preview: please provide feedback `_: Configure and manage Atlas Resource Policies within your organization.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.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.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.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.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.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.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.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.Returns, adds, edits, and removes Streams Instances. -* :ref:`atlas-api-teams` - `Public Preview: please provide feedback `_: Returns, adds, edits, or removes teams.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.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.Returns, edits, and removes user-managed X.509 configurations. +* :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-dataLakePipelines` - `Public Preview: please provide feedback `_: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. +* :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-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. .. toctree:: diff --git a/docs/command/atlas.txt b/docs/command/atlas.txt index e06426ead4..a19aa90b59 100644 --- a/docs/command/atlas.txt +++ b/docs/command/atlas.txt @@ -58,7 +58,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` - `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-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. diff --git a/internal/cli/api/api.go b/internal/cli/api/api.go index 871b966091..374b048e10 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: `Public Preview: please provide feedback _:` + `Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas 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. For more information on diff --git a/tools/cmd/docs/transformations.go b/tools/cmd/docs/transformations.go index b3edc5c905..748c07515f 100644 --- a/tools/cmd/docs/transformations.go +++ b/tools/cmd/docs/transformations.go @@ -60,7 +60,7 @@ 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.Short + cmd.Short = "`Public Preview: please provide feedback `_: " + cmd.Short } func updateAPICommandDescription(cmd *cobra.Command) {