From 12f277dfed44464404efc79a995a9bb46bd79a8d Mon Sep 17 00:00:00 2001 From: Jeroen Vervaeke Date: Wed, 29 Jan 2025 15:29:24 +0000 Subject: [PATCH 1/4] Added 'experimental: ' in every auto generated command without polluting --help --- ...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 +- .../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 +- ...sters-upgradeSharedClusterToServerless.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 +- ...ngoDbCloudUsers-removeOrganizationRole.txt | 2 +- ...pi-mongoDbCloudUsers-removeProjectRole.txt | 2 +- ...i-mongoDbCloudUsers-removeUserFromTeam.txt | 2 +- ...ngoDbCloudUsers-updateOrganizationUser.txt | 2 +- docs/command/atlas-api-mongoDbCloudUsers.txt | 30 ++--- ...-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 +-- .../atlas-api-openApi-getApiVersions.txt | 2 +- .../atlas-api-openApi-getOpenApiInfo.txt | 2 +- docs/command/atlas-api-openApi.txt | 6 +- ...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 +- ...pi-organizations-listOrganizationUsers.txt | 2 +- ...as-api-organizations-listOrganizations.txt | 2 +- ...i-organizations-removeOrganizationUser.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 | 36 +++--- ...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-listProjectUsers.txt | 2 +- .../atlas-api-projects-listProjects.txt | 2 +- ...pi-projects-migrateProjectToAnotherOrg.txt | 2 +- .../atlas-api-projects-removeProjectUser.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 | 52 ++++----- ...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 +- ...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 +- .../atlas-api-streams-stopStreamProcessor.txt | 2 +- ...las-api-streams-updateStreamConnection.txt | 2 +- ...atlas-api-streams-updateStreamInstance.txt | 2 +- docs/command/atlas-api-streams.txt | 58 +++++----- .../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 +- .../command/atlas-api-teams-listTeamUsers.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 | 28 ++--- .../atlas-api-test-versionedExample.txt | 2 +- docs/command/atlas-api-test.txt | 4 +- ...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 | 106 +++++++++--------- docs/command/atlas.txt | 2 +- internal/cli/api/api.go | 10 +- internal/cli/help_templates.go | 11 ++ internal/cli/root/builder.go | 7 +- tools/docs/main.go | 24 ++++ 511 files changed, 1056 insertions(+), 1020 deletions(-) create mode 100644 internal/cli/help_templates.go diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt index 86e4901244..ce0c22e104 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 -Returns the access logs of one cluster identified by the cluster's name. +experimental: Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. This command is invoking the endpoint with OperationID: 'listAccessLogsByClusterName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt index d44b958318..59973f3adc 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 -Returns the access logs of one cluster identified by the cluster's hostname. +experimental: Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. This command is invoking the endpoint with OperationID: 'listAccessLogsByHostname'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname diff --git a/docs/command/atlas-api-accessTracking.txt b/docs/command/atlas-api-accessTracking.txt index 141468e29c..7ee37daf98 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 -Returns access logs for authentication attempts made to Atlas database deployments. +experimental: 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 +51,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - Returns the access logs of one cluster identified by the cluster's name. -* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - Returns the access logs of one cluster identified by the cluster's hostname. +* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - experimental: Returns the access logs of one cluster identified by the cluster's name. +* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - experimental: 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 a7ddb9bdf0..1654eb37fd 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 -Creates one alert configuration for the specified project. +experimental: Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'createAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createAlertConfiguration diff --git a/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt index 84ad3393ec..9c9b1f53c8 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 -Removes one alert configuration from the specified project. +experimental: Removes one alert configuration from the specified project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'deleteAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/deleteAlertConfiguration diff --git a/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt index 660af39c16..fdd1caf1bc 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 -Returns the specified alert configuration from the specified project. +experimental: Returns the specified alert configuration from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'getAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getAlertConfiguration diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt index bcfbab0c19..0b156bc1bc 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 -Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. +experimental: 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. This command is invoking the endpoint with OperationID: 'listAlertConfigurationMatchersFieldNames'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationMatchersFieldNames diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt index 05413a53fd..005b435067 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 -Returns all alert configurations for one project. +experimental: Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlertConfigurations'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt index b171670651..7a59fc0bde 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 -Returns all alert configurations set for the specified alert. +experimental: Returns all alert configurations set for the specified alert. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlertConfigurationsByAlertId'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationsByAlertId diff --git a/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt index a0aafb1efa..e9cb921f36 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 -Enables or disables the specified alert configuration in the specified project. +experimental: Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. NOTE: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see Update One Alert Configuration. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'toggleAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration diff --git a/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt index 08385eb68f..2f2ed3cdbc 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 -Updates one alert configuration in the specified project. +experimental: Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. NOTE: To enable or disable the alert configuration, see Toggle One State of One Alert Configuration in One Project. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'updateAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateAlertConfiguration diff --git a/docs/command/atlas-api-alertConfigurations.txt b/docs/command/atlas-api-alertConfigurations.txt index 10e906633d..3bec951ea3 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 -Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. +experimental: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change. @@ -51,14 +51,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - Creates one alert configuration for the specified project. -* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - Removes one alert configuration from the specified project. -* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - Returns the specified alert configuration from the specified project. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - Returns all alert configurations for one project. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - Returns all alert configurations set for the specified alert. -* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - Enables or disables the specified alert configuration in the specified project. -* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - Updates one alert configuration in the specified project. +* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - experimental: Creates one alert configuration for the specified project. +* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - experimental: Removes one alert configuration from the specified project. +* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - experimental: Returns the specified alert configuration from the specified project. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - experimental: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - experimental: Returns all alert configurations for one project. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - experimental: Returns all alert configurations set for the specified alert. +* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - experimental: Enables or disables the specified alert configuration in the specified project. +* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - experimental: 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 c470ec255d..8ade35df56 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 -Confirms receipt of one existing alert. +experimental: Confirms receipt of one existing alert. This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'acknowledgeAlert'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeAlert diff --git a/docs/command/atlas-api-alerts-getAlert.txt b/docs/command/atlas-api-alerts-getAlert.txt index 6b43eba244..9f4c3b8cc6 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 -Returns one alert. +experimental: Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'getAlert'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getAlert diff --git a/docs/command/atlas-api-alerts-listAlerts.txt b/docs/command/atlas-api-alerts-listAlerts.txt index 63aaa2fac8..75e19dfa26 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 -Returns all alerts. +experimental: Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlerts'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts diff --git a/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt b/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt index 9ee6f69937..d32b8061de 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 -Returns all open alerts that the specified alert configuration triggers. +experimental: Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlertsByAlertConfigurationId'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlertsByAlertConfigurationId diff --git a/docs/command/atlas-api-alerts.txt b/docs/command/atlas-api-alerts.txt index a0203f50b3..6c94d1f104 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 -Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. +experimental: 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 +51,10 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alerts-acknowledgeAlert` - Confirms receipt of one existing alert. -* :ref:`atlas-api-alerts-getAlert` - Returns one alert. -* :ref:`atlas-api-alerts-listAlerts` - Returns all alerts. -* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - Returns all open alerts that the specified alert configuration triggers. +* :ref:`atlas-api-alerts-acknowledgeAlert` - experimental: Confirms receipt of one existing alert. +* :ref:`atlas-api-alerts-getAlert` - experimental: Returns one alert. +* :ref:`atlas-api-alerts-listAlerts` - experimental: Returns all alerts. +* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - experimental: 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 914a0d5c04..ecc8c20f1d 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 -Creates Search Nodes for the specified cluster. +experimental: Creates Search Nodes for the specified cluster. This command is invoking the endpoint with OperationID: 'createAtlasSearchDeployment'. For more information about flags, format of --file and examples, see: 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 030435fe40..a09202af0a 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 -Creates one Atlas Search index on the specified collection. +experimental: Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'createAtlasSearchIndex'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndex diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt index 4a9334077b..54ac8663a1 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 -Creates one Atlas Search index on the specified collection. +experimental: Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'createAtlasSearchIndexDeprecated'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndexDeprecated diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt index 1c2936422b..9b1e959425 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 -Deletes the Search Nodes for the specified cluster. +experimental: Deletes the Search Nodes for the specified cluster. This command is invoking the endpoint with OperationID: 'deleteAtlasSearchDeployment'. For more information about flags, format of --file and examples, see: 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 0290d1f0ba..e1f55e8488 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 -Removes one Atlas Search index that you identified with its unique ID. +experimental: Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent. This command is invoking the endpoint with OperationID: 'deleteAtlasSearchIndex'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndex diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt index 59f42c0d22..3888f4fc6f 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 -Removes one Atlas Search index that you identified with its database, collection, and name. +experimental: Removes one Atlas Search index that you identified with its database, collection, and name. To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent. This command is invoking the endpoint with OperationID: 'deleteAtlasSearchIndexByName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexByName diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt index 42bc985e1b..63519cd89c 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 -Removes one Atlas Search index that you identified with its unique ID. +experimental: Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'deleteAtlasSearchIndexDeprecated'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexDeprecated diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt index a2755872a3..3dd944b85a 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 -Return the Search Nodes for the specified cluster. +experimental: Return the Search Nodes for the specified cluster. This command is invoking the endpoint with OperationID: 'getAtlasSearchDeployment'. For more information about flags, format of --file and examples, see: 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 2832901a3c..2956bbb90d 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 -Returns one Atlas Search index in the specified project. +experimental: Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'getAtlasSearchIndex'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndex diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt index fd98c7d3ea..f1d0e1ed68 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 -Returns one Atlas Search index in the specified project. +experimental: Returns one Atlas Search index in the specified project. You identify this index using its database, collection and name. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'getAtlasSearchIndexByName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexByName diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt index 91be70e1a7..848379d462 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 -Returns one Atlas Search index in the specified project. +experimental: Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'getAtlasSearchIndexDeprecated'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexDeprecated diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt index ff1fb7fa1b..6be1c4ee31 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 -Returns all Atlas Search indexes on the specified collection. +experimental: Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'listAtlasSearchIndexes'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexes diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt index 414332cb46..1d33b8c76a 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 -Returns all Atlas Search indexes on the specified cluster. +experimental: Returns all Atlas Search indexes on the specified cluster. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'listAtlasSearchIndexesCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesCluster diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt index 63cdaf0fc6..1ac29d0520 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 -Returns all Atlas Search indexes on the specified collection. +experimental: Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'listAtlasSearchIndexesDeprecated'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesDeprecated diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt index 2973f0177b..0cea64c336 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 -Updates the Search Nodes for the specified cluster. +experimental: Updates the Search Nodes for the specified cluster. This command is invoking the endpoint with OperationID: 'updateAtlasSearchDeployment'. For more information about flags, format of --file and examples, see: 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 543b419804..f172e656df 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 -Updates one Atlas Search index that you identified with its unique ID. +experimental: Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'updateAtlasSearchIndex'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndex diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt index 4707f96c04..ab0b4c9be1 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 -Updates one Atlas Search index that you identified with its database, collection name, and index name. +experimental: Updates one Atlas Search index that you identified with its database, collection name, and index name. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'updateAtlasSearchIndexByName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexByName diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt index 57adbfdf79..6d15c117bb 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 -Updates one Atlas Search index that you identified with its unique ID. +experimental: Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'updateAtlasSearchIndexDeprecated'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexDeprecated diff --git a/docs/command/atlas-api-atlasSearch.txt b/docs/command/atlas-api-atlasSearch.txt index b3a5071838..cfa0a04758 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 -Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. +experimental: 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 +51,24 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-atlasSearch-createAtlasSearchDeployment` - Creates Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-createAtlasSearchIndex` - Creates one Atlas Search index on the specified collection. -* :ref:`atlas-api-atlasSearch-createAtlasSearchIndexDeprecated` - Creates one Atlas Search index on the specified collection. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchDeployment` - Deletes the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndex` - Removes one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexByName` - Removes one Atlas Search index that you identified with its database, collection, and name. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated` - Removes one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-getAtlasSearchDeployment` - Return the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndex` - Returns one Atlas Search index in the specified project. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexByName` - Returns one Atlas Search index in the specified project. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexDeprecated` - Returns one Atlas Search index in the specified project. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexes` - Returns all Atlas Search indexes on the specified collection. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesCluster` - Returns all Atlas Search indexes on the specified cluster. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated` - Returns all Atlas Search indexes on the specified collection. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchDeployment` - Updates the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndex` - Updates one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexByName` - Updates one Atlas Search index that you identified with its database, collection name, and index name. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated` - Updates one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-createAtlasSearchDeployment` - experimental: Creates Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-createAtlasSearchIndex` - experimental: Creates one Atlas Search index on the specified collection. +* :ref:`atlas-api-atlasSearch-createAtlasSearchIndexDeprecated` - experimental: Creates one Atlas Search index on the specified collection. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchDeployment` - experimental: Deletes the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndex` - experimental: Removes one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexByName` - experimental: Removes one Atlas Search index that you identified with its database, collection, and name. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated` - experimental: Removes one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-getAtlasSearchDeployment` - experimental: Return the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndex` - experimental: Returns one Atlas Search index in the specified project. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexByName` - experimental: Returns one Atlas Search index in the specified project. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexDeprecated` - experimental: Returns one Atlas Search index in the specified project. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexes` - experimental: Returns all Atlas Search indexes on the specified collection. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesCluster` - experimental: Returns all Atlas Search indexes on the specified cluster. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated` - experimental: Returns all Atlas Search indexes on the specified collection. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchDeployment` - experimental: Updates the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndex` - experimental: Updates one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexByName` - experimental: Updates one Atlas Search index that you identified with its database, collection name, and index name. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated` - experimental: 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 842b49831b..254e47a1ad 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 -Returns the auditing configuration for the specified project. +experimental: Returns the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. This command is invoking the endpoint with OperationID: 'getAuditingConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/getAuditingConfiguration diff --git a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt b/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt index d1c8efef94..46abfd26bd 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 -Updates the auditing configuration for the specified project. +experimental: Updates the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. This command is invoking the endpoint with OperationID: 'updateAuditingConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/updateAuditingConfiguration diff --git a/docs/command/atlas-api-auditing.txt b/docs/command/atlas-api-auditing.txt index 64cabd3b04..5c199c81bf 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 -Returns and edits database auditing settings for MongoDB Cloud projects. +experimental: Returns and edits database auditing settings for MongoDB Cloud projects. Options ------- @@ -49,8 +49,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-auditing-getAuditingConfiguration` - Returns the auditing configuration for the specified project. -* :ref:`atlas-api-auditing-updateAuditingConfiguration` - Updates the auditing configuration for the specified project. +* :ref:`atlas-api-auditing-getAuditingConfiguration` - experimental: Returns the auditing configuration for the specified project. +* :ref:`atlas-api-auditing-updateAuditingConfiguration` - experimental: 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 e0dab6776e..60baf871f5 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 -Returns the custom DNS configuration for AWS clusters in the specified project. +experimental: Returns the custom DNS configuration for AWS clusters in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getAwsCustomDns'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/getAwsCustomDns diff --git a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt index 400f41e86c..1eae68cad9 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 -Enables or disables the custom DNS configuration for AWS clusters in the specified project. +experimental: Enables or disables the custom DNS configuration for AWS clusters in the specified project. Enable custom DNS if you use AWS VPC peering and use your own DNS servers. To use this resource, the requesting API Key must have the Project Atlas Admin role. This command is invoking the endpoint with OperationID: 'toggleAwsCustomDns'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/toggleAwsCustomDns diff --git a/docs/command/atlas-api-awsClustersDns.txt b/docs/command/atlas-api-awsClustersDns.txt index 9cfff03a75..fc4a45f5ba 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 -Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. +experimental: 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 +51,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-awsClustersDns-getAwsCustomDns` - Returns the custom DNS configuration for AWS clusters in the specified project. -* :ref:`atlas-api-awsClustersDns-toggleAwsCustomDns` - Enables or disables the custom DNS configuration for AWS clusters in the specified project. +* :ref:`atlas-api-awsClustersDns-getAwsCustomDns` - experimental: Returns the custom DNS configuration for AWS clusters in the specified project. +* :ref:`atlas-api-awsClustersDns-toggleAwsCustomDns` - experimental: 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 991aa428df..07cca2bea3 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 -Cancels one cloud backup restore job of one cluster from the specified project. +experimental: Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'cancelBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelBackupRestoreJob diff --git a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt index 19e0487d28..2e5f9318f6 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 -Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. +experimental: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role. This command is invoking the endpoint with OperationID: 'createBackupExportJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupExportJob diff --git a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt index fa6b873fc1..cdeb18172f 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 -Restores one snapshot of one cluster from the specified project. +experimental: Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupRestoreJob diff --git a/docs/command/atlas-api-cloudBackups-createExportBucket.txt b/docs/command/atlas-api-cloudBackups-createExportBucket.txt index ff54dcbeda..98f883fb91 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 -Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. +experimental: Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createExportBucket'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createExportBucket diff --git a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt index bda2906513..0d5aafd3b5 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 -Restores one snapshot of one serverless instance from the specified project. +experimental: Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createServerlessBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createServerlessBackupRestoreJob diff --git a/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt b/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt index 6ac5be3c9c..81664be7e7 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 -Removes all cloud backup schedules for the specified cluster. +experimental: Removes all cloud backup schedules for the specified cluster. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Atlas Admin role. This command is invoking the endpoint with OperationID: 'deleteAllBackupSchedules'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteAllBackupSchedules diff --git a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt index 37b1dec085..018cb766c2 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 -Deletes an Export Bucket. +experimental: Deletes an Export Bucket. Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteExportBucket'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteExportBucket diff --git a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt index 0352aed936..41cacd83f2 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 -Removes the specified snapshot. +experimental: Removes the specified snapshot. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteReplicaSetBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteReplicaSetBackup diff --git a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt index 4359d5a238..93ed74a9b4 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 -Removes one snapshot of one sharded cluster from the specified project. +experimental: Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteShardedClusterBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteShardedClusterBackup diff --git a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt index 3a16b0f06b..08af58e53f 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 -Disables the Backup Compliance Policy settings with the specified project. +experimental: 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 API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'disableDataProtectionSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/disableDataProtectionSettings diff --git a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt index 4e5977fd73..71da56442f 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 -Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. +experimental: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. This command is invoking the endpoint with OperationID: 'getBackupExportJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupExportJob diff --git a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt index 908dd1e859..5e2088e30e 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 -Returns one cloud backup restore job for one cluster from the specified project. +experimental: Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupRestoreJob diff --git a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt index f46d9bcccd..1e26f8cbb5 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 -Returns the cloud backup schedule for the specified cluster within the specified project. +experimental: Returns the cloud backup schedule for the specified cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getBackupSchedule'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupSchedule diff --git a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt index e0abc2767d..1cc2a01419 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 -Returns the Backup Compliance Policy settings with the specified project. +experimental: Returns the Backup Compliance Policy settings with the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getDataProtectionSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getDataProtectionSettings diff --git a/docs/command/atlas-api-cloudBackups-getExportBucket.txt b/docs/command/atlas-api-cloudBackups-getExportBucket.txt index ca0424738a..abfcbb12a7 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 -Returns one Export Bucket associated with the specified Project. +experimental: Returns one Export Bucket associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getExportBucket'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getExportBucket diff --git a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt index 3c3f98710d..26e79db745 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 -Returns one snapshot from the specified cluster. +experimental: Returns one snapshot from the specified cluster. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getReplicaSetBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getReplicaSetBackup diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt index 83b30c9b0a..d1be2eaec5 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 -Returns one snapshot of one serverless instance from the specified project. +experimental: Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getServerlessBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackup diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt index ec183d2c79..45ebbe06f6 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 -Returns one restore job for one serverless instance from the specified project. +experimental: Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getServerlessBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackupRestoreJob diff --git a/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt index 74a1cc84d7..6f1fea4976 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 -Returns one snapshot of one sharded cluster from the specified project. +experimental: Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getShardedClusterBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getShardedClusterBackup diff --git a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt index 28bd204cb3..74c7606918 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 -Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. +experimental: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. This command is invoking the endpoint with OperationID: 'listBackupExportJobs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupExportJobs diff --git a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt index 7a4aa9d420..5678ada950 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 -Returns all cloud backup restore jobs for one cluster from the specified project. +experimental: Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'listBackupRestoreJobs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupRestoreJobs diff --git a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt index 0c1a0bdeca..7c4a448d93 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 -Returns all Export Buckets associated with the specified Project. +experimental: Returns all Export Buckets associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listExportBuckets'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listExportBuckets diff --git a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt b/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt index fb06e380af..80f2c22d8b 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 -Returns all snapshots of one cluster from the specified project. +experimental: Returns all snapshots of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listReplicaSetBackups'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listReplicaSetBackups diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt index 016ec8ccbe..766c3e234f 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 -Returns all restore jobs for one serverless instance from the specified project. +experimental: Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'listServerlessBackupRestoreJobs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackupRestoreJobs diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt index 311791545b..b6eaffa868 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 -Returns all snapshots of one serverless instance from the specified project. +experimental: Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listServerlessBackups'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackups diff --git a/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt b/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt index ef1acfb52a..4d387b2e23 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 -Returns all snapshots of one sharded cluster from the specified project. +experimental: Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listShardedClusterBackups'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listShardedClusterBackups diff --git a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt b/docs/command/atlas-api-cloudBackups-takeSnapshot.txt index 054f359837..3d2c32d045 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 -Takes one on-demand snapshot for the specified cluster. +experimental: Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'takeSnapshot'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/takeSnapshot diff --git a/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt index 7765dd71dd..f6a8c41684 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 -Updates the cloud backup schedule for one cluster within the specified project. +experimental: Updates the cloud backup schedule for one cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateBackupSchedule'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateBackupSchedule diff --git a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt index 59dfd3e5a1..59d6d3b88c 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 -Updates the Backup Compliance Policy settings for the specified project. +experimental: Updates the Backup Compliance Policy settings for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateDataProtectionSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateDataProtectionSettings diff --git a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt b/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt index 707aab4a16..8c6f8dcbac 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 -Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +experimental: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. This command is invoking the endpoint with OperationID: 'updateSnapshotRetention'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateSnapshotRetention diff --git a/docs/command/atlas-api-cloudBackups.txt b/docs/command/atlas-api-cloudBackups.txt index 9b183c4b30..8c592543c0 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 -Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. +experimental: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups. @@ -51,36 +51,36 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudBackups-cancelBackupRestoreJob` - Cancels one cloud backup restore job of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-createBackupExportJob` - Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. -* :ref:`atlas-api-cloudBackups-createBackupRestoreJob` - Restores one snapshot of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-createExportBucket` - Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. -* :ref:`atlas-api-cloudBackups-createServerlessBackupRestoreJob` - Restores one snapshot of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-deleteAllBackupSchedules` - Removes all cloud backup schedules for the specified cluster. -* :ref:`atlas-api-cloudBackups-deleteExportBucket` - Deletes an Export Bucket. -* :ref:`atlas-api-cloudBackups-deleteReplicaSetBackup` - Removes the specified snapshot. -* :ref:`atlas-api-cloudBackups-deleteShardedClusterBackup` - Removes one snapshot of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-disableDataProtectionSettings` - Disables the Backup Compliance Policy settings with the specified project. -* :ref:`atlas-api-cloudBackups-getBackupExportJob` - Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. -* :ref:`atlas-api-cloudBackups-getBackupRestoreJob` - Returns one cloud backup restore job for one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-getBackupSchedule` - Returns the cloud backup schedule for the specified cluster within the specified project. -* :ref:`atlas-api-cloudBackups-getDataProtectionSettings` - Returns the Backup Compliance Policy settings with the specified project. -* :ref:`atlas-api-cloudBackups-getExportBucket` - Returns one Export Bucket associated with the specified Project. -* :ref:`atlas-api-cloudBackups-getReplicaSetBackup` - Returns one snapshot from the specified cluster. -* :ref:`atlas-api-cloudBackups-getServerlessBackup` - Returns one snapshot of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-getServerlessBackupRestoreJob` - Returns one restore job for one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-getShardedClusterBackup` - Returns one snapshot of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listBackupExportJobs` - Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. -* :ref:`atlas-api-cloudBackups-listBackupRestoreJobs` - Returns all cloud backup restore jobs for one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listExportBuckets` - Returns all Export Buckets associated with the specified Project. -* :ref:`atlas-api-cloudBackups-listReplicaSetBackups` - Returns all snapshots of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listServerlessBackupRestoreJobs` - Returns all restore jobs for one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-listServerlessBackups` - Returns all snapshots of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-listShardedClusterBackups` - Returns all snapshots of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-takeSnapshot` - Takes one on-demand snapshot for the specified cluster. -* :ref:`atlas-api-cloudBackups-updateBackupSchedule` - Updates the cloud backup schedule for one cluster within the specified project. -* :ref:`atlas-api-cloudBackups-updateDataProtectionSettings` - Updates the Backup Compliance Policy settings for the specified project. -* :ref:`atlas-api-cloudBackups-updateSnapshotRetention` - Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-cloudBackups-cancelBackupRestoreJob` - experimental: Cancels one cloud backup restore job of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-createBackupExportJob` - experimental: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. +* :ref:`atlas-api-cloudBackups-createBackupRestoreJob` - experimental: Restores one snapshot of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-createExportBucket` - experimental: Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. +* :ref:`atlas-api-cloudBackups-createServerlessBackupRestoreJob` - experimental: Restores one snapshot of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-deleteAllBackupSchedules` - experimental: Removes all cloud backup schedules for the specified cluster. +* :ref:`atlas-api-cloudBackups-deleteExportBucket` - experimental: Deletes an Export Bucket. +* :ref:`atlas-api-cloudBackups-deleteReplicaSetBackup` - experimental: Removes the specified snapshot. +* :ref:`atlas-api-cloudBackups-deleteShardedClusterBackup` - experimental: Removes one snapshot of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-disableDataProtectionSettings` - experimental: Disables the Backup Compliance Policy settings with the specified project. +* :ref:`atlas-api-cloudBackups-getBackupExportJob` - experimental: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. +* :ref:`atlas-api-cloudBackups-getBackupRestoreJob` - experimental: Returns one cloud backup restore job for one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-getBackupSchedule` - experimental: Returns the cloud backup schedule for the specified cluster within the specified project. +* :ref:`atlas-api-cloudBackups-getDataProtectionSettings` - experimental: Returns the Backup Compliance Policy settings with the specified project. +* :ref:`atlas-api-cloudBackups-getExportBucket` - experimental: Returns one Export Bucket associated with the specified Project. +* :ref:`atlas-api-cloudBackups-getReplicaSetBackup` - experimental: Returns one snapshot from the specified cluster. +* :ref:`atlas-api-cloudBackups-getServerlessBackup` - experimental: Returns one snapshot of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-getServerlessBackupRestoreJob` - experimental: Returns one restore job for one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-getShardedClusterBackup` - experimental: Returns one snapshot of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listBackupExportJobs` - experimental: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. +* :ref:`atlas-api-cloudBackups-listBackupRestoreJobs` - experimental: Returns all cloud backup restore jobs for one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listExportBuckets` - experimental: Returns all Export Buckets associated with the specified Project. +* :ref:`atlas-api-cloudBackups-listReplicaSetBackups` - experimental: Returns all snapshots of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listServerlessBackupRestoreJobs` - experimental: Returns all restore jobs for one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-listServerlessBackups` - experimental: Returns all snapshots of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-listShardedClusterBackups` - experimental: Returns all snapshots of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-takeSnapshot` - experimental: Takes one on-demand snapshot for the specified cluster. +* :ref:`atlas-api-cloudBackups-updateBackupSchedule` - experimental: Updates the cloud backup schedule for one cluster within the specified project. +* :ref:`atlas-api-cloudBackups-updateDataProtectionSettings` - experimental: Updates the Backup Compliance Policy settings for the specified project. +* :ref:`atlas-api-cloudBackups-updateSnapshotRetention` - experimental: 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 ae17abb38e..e0082ccef4 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 -Create one link-token that contains all the information required to complete the link. +experimental: 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. This command is invoking the endpoint with OperationID: 'createLinkToken'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createLinkToken diff --git a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt index 038e30e7c6..dddfac0912 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 -Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. +experimental: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. Please make sure to validate your migration before initiating it. You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource. NOTE: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster. This command is invoking the endpoint with OperationID: 'createPushMigration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createPushMigration diff --git a/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt b/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt index 7c9cad6d5d..1bb30248ff 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 -Cut over the migrated cluster to MongoDB Atlas. +experimental: 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. This command is invoking the endpoint with OperationID: 'cutoverMigration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/cutoverMigration diff --git a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt b/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt index b3fbcc8bc1..a9dbafe69a 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 -Remove one organization link and its associated public API key. +experimental: 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. This command is invoking the endpoint with OperationID: 'deleteLinkToken'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/deleteLinkToken diff --git a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt index b9ee591bd2..8c0e547511 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 -Return details of one cluster migration job. +experimental: 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. This command is invoking the endpoint with OperationID: 'getPushMigration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getPushMigration diff --git a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt b/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt index e686da2ff0..8bc97c0fe9 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 -Return the status of one migration validation job. +experimental: Return the status of one migration validation job. Your API Key must have the Organization Owner role to successfully call this resource. This command is invoking the endpoint with OperationID: 'getValidationStatus'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getValidationStatus diff --git a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt b/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt index 19e78602f6..d06f6a500c 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 -Return all projects that you can migrate to the specified organization. +experimental: Return all projects that you can migrate to the specified organization. This command is invoking the endpoint with OperationID: 'listSourceProjects'. For more information about flags, format of --file and examples, see: 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 5629f68901..9b89932bf4 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 -Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. +experimental: 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. This command is invoking the endpoint with OperationID: 'validateMigration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateMigration diff --git a/docs/command/atlas-api-cloudMigrationService.txt b/docs/command/atlas-api-cloudMigrationService.txt index 338eec7c3a..ff7374e576 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 -Manages the Cloud Migration Service. +experimental: 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 +51,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudMigrationService-createLinkToken` - Create one link-token that contains all the information required to complete the link. -* :ref:`atlas-api-cloudMigrationService-createPushMigration` - Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. -* :ref:`atlas-api-cloudMigrationService-cutoverMigration` - Cut over the migrated cluster to MongoDB Atlas. -* :ref:`atlas-api-cloudMigrationService-deleteLinkToken` - Remove one organization link and its associated public API key. -* :ref:`atlas-api-cloudMigrationService-getPushMigration` - Return details of one cluster migration job. -* :ref:`atlas-api-cloudMigrationService-getValidationStatus` - Return the status of one migration validation job. -* :ref:`atlas-api-cloudMigrationService-listSourceProjects` - Return all projects that you can migrate to the specified organization. -* :ref:`atlas-api-cloudMigrationService-validateMigration` - Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. +* :ref:`atlas-api-cloudMigrationService-createLinkToken` - experimental: Create one link-token that contains all the information required to complete the link. +* :ref:`atlas-api-cloudMigrationService-createPushMigration` - experimental: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. +* :ref:`atlas-api-cloudMigrationService-cutoverMigration` - experimental: Cut over the migrated cluster to MongoDB Atlas. +* :ref:`atlas-api-cloudMigrationService-deleteLinkToken` - experimental: Remove one organization link and its associated public API key. +* :ref:`atlas-api-cloudMigrationService-getPushMigration` - experimental: Return details of one cluster migration job. +* :ref:`atlas-api-cloudMigrationService-getValidationStatus` - experimental: Return the status of one migration validation job. +* :ref:`atlas-api-cloudMigrationService-listSourceProjects` - experimental: Return all projects that you can migrate to the specified organization. +* :ref:`atlas-api-cloudMigrationService-validateMigration` - experimental: 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 a07837b18e..c887be6825 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 -Grants access to the specified project for the specified access role. +experimental: Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. This is not required for GCP service account access. This command is invoking the endpoint with OperationID: 'authorizeCloudProviderAccessRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/authorizeCloudProviderAccessRole diff --git a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt index ed599f3e4c..46f94f9f00 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 -Creates one access role for the specified cloud provider. +experimental: Creates one access role for the specified cloud provider. Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createCloudProviderAccessRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/createCloudProviderAccessRole diff --git a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt index 48f68992cb..8e99349af8 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 -Revokes access to the specified project for the specified access role. +experimental: Revokes access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deauthorizeCloudProviderAccessRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/deauthorizeCloudProviderAccessRole diff --git a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt index 1d6d53c4f2..5f8098cd91 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 -Returns the access role with the specified id and with access to the specified project. +experimental: Returns the access role with the specified id and with access to the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getCloudProviderAccessRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/getCloudProviderAccessRole diff --git a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt index 38a8d8b5ef..44a7f3c366 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 -Returns all cloud provider access roles with access to the specified project. +experimental: Returns all cloud provider access roles with access to the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'listCloudProviderAccessRoles'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/listCloudProviderAccessRoles diff --git a/docs/command/atlas-api-cloudProviderAccess.txt b/docs/command/atlas-api-cloudProviderAccess.txt index a22dbd2df1..b37ae2b95d 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 -Returns, adds, authorizes, and removes AWS IAM roles in Atlas. +experimental: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. Options ------- @@ -49,11 +49,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole` - Grants access to the specified project for the specified access role. -* :ref:`atlas-api-cloudProviderAccess-createCloudProviderAccessRole` - Creates one access role for the specified cloud provider. -* :ref:`atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole` - Revokes access to the specified project for the specified access role. -* :ref:`atlas-api-cloudProviderAccess-getCloudProviderAccessRole` - Returns the access role with the specified id and with access to the specified project. -* :ref:`atlas-api-cloudProviderAccess-listCloudProviderAccessRoles` - Returns all cloud provider access roles with access to the specified project. +* :ref:`atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole` - experimental: Grants access to the specified project for the specified access role. +* :ref:`atlas-api-cloudProviderAccess-createCloudProviderAccessRole` - experimental: Creates one access role for the specified cloud provider. +* :ref:`atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole` - experimental: Revokes access to the specified project for the specified access role. +* :ref:`atlas-api-cloudProviderAccess-getCloudProviderAccessRole` - experimental: Returns the access role with the specified id and with access to the specified project. +* :ref:`atlas-api-cloudProviderAccess-listCloudProviderAccessRoles` - experimental: 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 5ba440045a..20d6f43816 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 -Ends a cluster outage simulation. +experimental: Ends a cluster outage simulation. This command is invoking the endpoint with OperationID: 'endOutageSimulation'. For more information about flags, format of --file and examples, see: 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 db946da962..0fac65bff4 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 -Returns one outage simulation for one cluster. +experimental: Returns one outage simulation for one cluster. This command is invoking the endpoint with OperationID: 'getOutageSimulation'. For more information about flags, format of --file and examples, see: 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 e56990a875..f71de5d7b8 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 -Starts a cluster outage simulation. +experimental: Starts a cluster outage simulation. This command is invoking the endpoint with OperationID: 'startOutageSimulation'. For more information about flags, format of --file and examples, see: 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 18624d4d62..140defea68 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 -Returns, starts, or ends a cluster outage simulation. +experimental: Returns, starts, or ends a cluster outage simulation. Options ------- @@ -49,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-clusterOutageSimulation-endOutageSimulation` - Ends a cluster outage simulation. -* :ref:`atlas-api-clusterOutageSimulation-getOutageSimulation` - Returns one outage simulation for one cluster. -* :ref:`atlas-api-clusterOutageSimulation-startOutageSimulation` - Starts a cluster outage simulation. +* :ref:`atlas-api-clusterOutageSimulation-endOutageSimulation` - experimental: Ends a cluster outage simulation. +* :ref:`atlas-api-clusterOutageSimulation-getOutageSimulation` - experimental: Returns one outage simulation for one cluster. +* :ref:`atlas-api-clusterOutageSimulation-startOutageSimulation` - experimental: Starts a cluster outage simulation. .. toctree:: diff --git a/docs/command/atlas-api-clusters-createCluster.txt b/docs/command/atlas-api-clusters-createCluster.txt index f3b49827e7..a825313332 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 -Creates one cluster in the specified project. +experimental: Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters. This command is invoking the endpoint with OperationID: 'createCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster diff --git a/docs/command/atlas-api-clusters-deleteCluster.txt b/docs/command/atlas-api-clusters-deleteCluster.txt index 2bf5af96de..c9914ae647 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 -Removes one cluster from the specified project. +experimental: Removes one cluster from the specified project. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters. This command is invoking the endpoint with OperationID: 'deleteCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/deleteCluster diff --git a/docs/command/atlas-api-clusters-getCluster.txt b/docs/command/atlas-api-clusters-getCluster.txt index ef649e51a0..2f9ac4372c 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 -Returns the details for one cluster in the specified project. +experimental: Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. This command is invoking the endpoint with OperationID: 'getCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster diff --git a/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt index 54fce54dda..1cbcddc0ab 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 -Returns the advanced configuration details for one cluster in the specified project. +experimental: 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 API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getClusterAdvancedConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterAdvancedConfiguration diff --git a/docs/command/atlas-api-clusters-getClusterStatus.txt b/docs/command/atlas-api-clusters-getClusterStatus.txt index fdb0cf1e18..5f9a8c788a 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 -Returns the status of all changes that you made to the specified cluster in the specified project. +experimental: Returns the status of all changes that you made to the specified cluster in the specified project. Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getClusterStatus'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterStatus diff --git a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt b/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt index 01cc01b1a8..411b92ef06 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 -Checks the progress of loading the sample dataset into one cluster. +experimental: Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getSampleDatasetLoadStatus'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getSampleDatasetLoadStatus diff --git a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt index 524c85d90a..09d9037292 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 -Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. +experimental: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. This command is invoking the endpoint with OperationID: 'grantMongoDbEmployeeAccess'. For more information about flags, format of --file and examples, see: 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 6e8f7e1f44..6d3167ce0d 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 -Returns the list of regions available for the specified cloud provider at the specified tier. +experimental: Returns the list of regions available for the specified cloud provider at the specified tier. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listCloudProviderRegions'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listCloudProviderRegions diff --git a/docs/command/atlas-api-clusters-listClusters.txt b/docs/command/atlas-api-clusters-listClusters.txt index f83d29cdd1..ee5a0ccac9 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 -Returns the details for all clusters in the specific project to which you have access. +experimental: Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. This command is invoking the endpoint with OperationID: 'listClusters'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusters diff --git a/docs/command/atlas-api-clusters-listClustersForAllProjects.txt b/docs/command/atlas-api-clusters-listClustersForAllProjects.txt index ed7ecfcaa8..464bbe181a 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 -Returns the details for all clusters in all projects to which you have access. +experimental: Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting API Key can have any cluster-level role. This command is invoking the endpoint with OperationID: 'listClustersForAllProjects'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClustersForAllProjects diff --git a/docs/command/atlas-api-clusters-loadSampleDataset.txt b/docs/command/atlas-api-clusters-loadSampleDataset.txt index 0f80a10aab..1546e8b49d 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 -Requests loading the MongoDB sample dataset into the specified cluster. +experimental: Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'loadSampleDataset'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/loadSampleDataset diff --git a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt index 9f7536454d..9585dac9e8 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 -Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. +experimental: 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. This command is invoking the endpoint with OperationID: 'pinFeatureCompatibilityVersion'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/pinFeatureCompatibilityVersion diff --git a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt index 495a0faf93..8ccc1e7192 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 -Revokes a previously granted MongoDB employee cluster access. +experimental: Revokes a previously granted MongoDB employee cluster access. This command is invoking the endpoint with OperationID: 'revokeMongoDbEmployeeAccess'. For more information about flags, format of --file and examples, see: 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 04ab8b2bc3..910c372be1 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 -Starts a failover test for the specified cluster in the specified project. +experimental: Starts a failover test for the specified cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting API Key must have the Project Cluster Manager role. This command is invoking the endpoint with OperationID: 'testFailover'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/testFailover diff --git a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt index b3f0c923ea..f0f299766d 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 -Unpins the current fixed Feature Compatibility Version (FCV). +experimental: Unpins the current fixed Feature Compatibility Version (FCV). This feature is not available for clusters on rapid release. This command is invoking the endpoint with OperationID: 'unpinFeatureCompatibilityVersion'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/unpinFeatureCompatibilityVersion diff --git a/docs/command/atlas-api-clusters-updateCluster.txt b/docs/command/atlas-api-clusters-updateCluster.txt index 639daa9d99..8e63634425 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 -Updates the details for one cluster in the specified project. +experimental: Updates the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can update clusters with asymmetrically-sized shards. To update a cluster's termination protection, the requesting API Key must have the Project Owner role. For all other updates, the requesting API Key must have the Project Cluster Manager role. You can't modify a paused cluster (paused : true). You must call this endpoint to set paused : false. After this endpoint responds with paused : false, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters. This command is invoking the endpoint with OperationID: 'updateCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateCluster diff --git a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt index 54124208dc..c9baa9229e 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 -Updates the advanced configuration details for one cluster in the specified project. +experimental: Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting API Key must have the Project Cluster Manager role. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. This command is invoking the endpoint with OperationID: 'updateClusterAdvancedConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateClusterAdvancedConfiguration diff --git a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt b/docs/command/atlas-api-clusters-upgradeSharedCluster.txt index f47bdad5b3..38c912e1ef 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 -Upgrades a shared-tier cluster to a dedicated cluster (M10+) in the specified project. +experimental: Upgrades a shared-tier cluster to a dedicated cluster (M10+) in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. Each project supports up to 25 clusters. This command is invoking the endpoint with OperationID: 'upgradeSharedCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedCluster diff --git a/docs/command/atlas-api-clusters-upgradeSharedClusterToServerless.txt b/docs/command/atlas-api-clusters-upgradeSharedClusterToServerless.txt index b1024cd70f..4d3c536a3f 100644 --- a/docs/command/atlas-api-clusters-upgradeSharedClusterToServerless.txt +++ b/docs/command/atlas-api-clusters-upgradeSharedClusterToServerless.txt @@ -12,7 +12,7 @@ atlas api clusters upgradeSharedClusterToServerless :depth: 1 :class: singlecol -Upgrades a shared-tier cluster to a serverless instance in the specified project. +experimental: Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. This command is invoking the endpoint with OperationID: 'upgradeSharedClusterToServerless'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedClusterToServerless diff --git a/docs/command/atlas-api-clusters.txt b/docs/command/atlas-api-clusters.txt index cd90dbe059..3e1d352b38 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 -Returns, adds, edits, and removes database deployments. +experimental: Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID. @@ -51,25 +51,25 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-clusters-createCluster` - Creates one cluster in the specified project. -* :ref:`atlas-api-clusters-deleteCluster` - Removes one cluster from the specified project. -* :ref:`atlas-api-clusters-getCluster` - Returns the details for one cluster in the specified project. -* :ref:`atlas-api-clusters-getClusterAdvancedConfiguration` - Returns the advanced configuration details for one cluster in the specified project. -* :ref:`atlas-api-clusters-getClusterStatus` - Returns the status of all changes that you made to the specified cluster in the specified project. -* :ref:`atlas-api-clusters-getSampleDatasetLoadStatus` - Checks the progress of loading the sample dataset into one cluster. -* :ref:`atlas-api-clusters-grantMongoDbEmployeeAccess` - Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. -* :ref:`atlas-api-clusters-listCloudProviderRegions` - Returns the list of regions available for the specified cloud provider at the specified tier. -* :ref:`atlas-api-clusters-listClusters` - Returns the details for all clusters in the specific project to which you have access. -* :ref:`atlas-api-clusters-listClustersForAllProjects` - Returns the details for all clusters in all projects to which you have access. -* :ref:`atlas-api-clusters-loadSampleDataset` - Requests loading the MongoDB sample dataset into the specified cluster. -* :ref:`atlas-api-clusters-pinFeatureCompatibilityVersion` - Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. -* :ref:`atlas-api-clusters-revokeMongoDbEmployeeAccess` - Revokes a previously granted MongoDB employee cluster access. -* :ref:`atlas-api-clusters-testFailover` - Starts a failover test for the specified cluster in the specified project. -* :ref:`atlas-api-clusters-unpinFeatureCompatibilityVersion` - Unpins the current fixed Feature Compatibility Version (FCV). -* :ref:`atlas-api-clusters-updateCluster` - Updates the details for one cluster in the specified project. -* :ref:`atlas-api-clusters-updateClusterAdvancedConfiguration` - Updates the advanced configuration details for one cluster in the specified project. -* :ref:`atlas-api-clusters-upgradeSharedCluster` - Upgrades a shared-tier cluster to a dedicated cluster (M10+) in the specified project. -* :ref:`atlas-api-clusters-upgradeSharedClusterToServerless` - Upgrades a shared-tier cluster to a serverless instance in the specified project. +* :ref:`atlas-api-clusters-createCluster` - experimental: Creates one cluster in the specified project. +* :ref:`atlas-api-clusters-deleteCluster` - experimental: Removes one cluster from the specified project. +* :ref:`atlas-api-clusters-getCluster` - experimental: Returns the details for one cluster in the specified project. +* :ref:`atlas-api-clusters-getClusterAdvancedConfiguration` - experimental: Returns the advanced configuration details for one cluster in the specified project. +* :ref:`atlas-api-clusters-getClusterStatus` - experimental: Returns the status of all changes that you made to the specified cluster in the specified project. +* :ref:`atlas-api-clusters-getSampleDatasetLoadStatus` - experimental: Checks the progress of loading the sample dataset into one cluster. +* :ref:`atlas-api-clusters-grantMongoDbEmployeeAccess` - experimental: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. +* :ref:`atlas-api-clusters-listCloudProviderRegions` - experimental: Returns the list of regions available for the specified cloud provider at the specified tier. +* :ref:`atlas-api-clusters-listClusters` - experimental: Returns the details for all clusters in the specific project to which you have access. +* :ref:`atlas-api-clusters-listClustersForAllProjects` - experimental: Returns the details for all clusters in all projects to which you have access. +* :ref:`atlas-api-clusters-loadSampleDataset` - experimental: Requests loading the MongoDB sample dataset into the specified cluster. +* :ref:`atlas-api-clusters-pinFeatureCompatibilityVersion` - experimental: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. +* :ref:`atlas-api-clusters-revokeMongoDbEmployeeAccess` - experimental: Revokes a previously granted MongoDB employee cluster access. +* :ref:`atlas-api-clusters-testFailover` - experimental: Starts a failover test for the specified cluster in the specified project. +* :ref:`atlas-api-clusters-unpinFeatureCompatibilityVersion` - experimental: Unpins the current fixed Feature Compatibility Version (FCV). +* :ref:`atlas-api-clusters-updateCluster` - experimental: Updates the details for one cluster in the specified project. +* :ref:`atlas-api-clusters-updateClusterAdvancedConfiguration` - experimental: Updates the advanced configuration details for one cluster in the specified project. +* :ref:`atlas-api-clusters-upgradeSharedCluster` - experimental: Upgrades a shared-tier cluster to a dedicated cluster (M10+) in the specified project. +* :ref:`atlas-api-clusters-upgradeSharedClusterToServerless` - experimental: Upgrades a shared-tier cluster to a serverless instance in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt index 952578696f..b52c6007c8 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 -Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. +experimental: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. This command is invoking the endpoint with OperationID: 'getCollStatsLatencyNamespaceClusterMeasurements'. For more information about flags, format of --file and examples, see: 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 f70c982c48..736b4b5f2b 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 -Get a list of the Coll Stats Latency process-level measurements for the given namespace +experimental: Get a list of the Coll Stats Latency process-level measurements for the given namespace This command is invoking the endpoint with OperationID: 'getCollStatsLatencyNamespaceHostMeasurements'. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt index 5b46bda450..9581bd3bfc 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 -Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. +experimental: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. This command is invoking the endpoint with OperationID: 'getCollStatsLatencyNamespaceMetrics'. For more information about flags, format of --file and examples, see: 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 f60be84326..cc7399b90b 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 -Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. +experimental: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. This command is invoking the endpoint with OperationID: 'getCollStatsLatencyNamespacesForCluster'. For more information about flags, format of --file and examples, see: 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 fe453c3161..394e802fb2 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 -Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. +experimental: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. This command is invoking the endpoint with OperationID: 'getCollStatsLatencyNamespacesForHost'. For more information about flags, format of --file and examples, see: 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 e5f99cae25..a8380eb1dc 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 -Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. +experimental: 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 invoking the endpoint with OperationID: 'getPinnedNamespaces'. For more information about flags, format of --file and examples, see: 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 4f42460b35..07f0322cf9 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 -Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster +experimental: 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 invoking the endpoint with OperationID: 'pinNamespacesPatch'. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt index 30965c62d8..8df2f19300 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 -Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +experimental: 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. This command is invoking the endpoint with OperationID: 'pinNamespacesPut'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPut diff --git a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt index 36576269ea..dbe89f2f96 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 -Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster +experimental: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster This command is invoking the endpoint with OperationID: 'unpinNamespaces'. diff --git a/docs/command/atlas-api-collectionLevelMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics.txt index edcd4f7d90..5fb5687eb4 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 -Returns, adds, and edits pinned namespaces for the specified cluster or process. +experimental: Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level latency metric data. @@ -51,19 +51,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements` - Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements` - Get a list of the Coll Stats Latency process-level measurements for the given namespace +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements` - experimental: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements` - experimental: Get a list of the Coll Stats Latency process-level measurements for the given namespace This command is invoking the endpoint with OperationID: 'getCollStatsLatencyNamespaceHostMeasurements'. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics` - Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForCluster` - Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespacesForHost` - Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. -* :ref:`atlas-api-collectionLevelMetrics-getPinnedNamespaces` - Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. -* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPatch` - Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics` - experimental: 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` - experimental: 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` - experimental: 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` - experimental: 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` - experimental: 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 invoking the endpoint with OperationID: 'pinNamespacesPatch'. -* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPut` - Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. -* :ref:`atlas-api-collectionLevelMetrics-unpinNamespaces` - Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster +* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPut` - experimental: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +* :ref:`atlas-api-collectionLevelMetrics-unpinNamespaces` - experimental: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster This command is invoking the endpoint with OperationID: 'unpinNamespaces'. diff --git a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt index 1a0449023f..259db6f6fa 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 -Creates one custom role in the specified project. +experimental: Creates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createCustomDatabaseRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/createCustomDatabaseRole diff --git a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt index a90c1254b6..8f7beb4f75 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 -Removes one custom role from the specified project. +experimental: Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting API Key must have the Project Atlas Admin role. This command is invoking the endpoint with OperationID: 'deleteCustomDatabaseRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/deleteCustomDatabaseRole diff --git a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt index 861cedb03e..8f40936805 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 -Returns one custom role for the specified project. +experimental: Returns one custom role for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getCustomDatabaseRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/getCustomDatabaseRole diff --git a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt index 739f2a1b46..25fa52dd2f 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 -Returns all custom roles for the specified project. +experimental: Returns all custom roles for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listCustomDatabaseRoles'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/listCustomDatabaseRoles diff --git a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt index f5872032e6..c57afdffbb 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 -Updates one custom role in the specified project. +experimental: Updates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateCustomDatabaseRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/updateCustomDatabaseRole diff --git a/docs/command/atlas-api-customDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles.txt index 8dd6fc3d7a..39270958c0 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 -Returns, adds, edits, and removes custom database user privilege roles. +experimental: 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 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-customDatabaseRoles-createCustomDatabaseRole` - Creates one custom role in the specified project. -* :ref:`atlas-api-customDatabaseRoles-deleteCustomDatabaseRole` - Removes one custom role from the specified project. -* :ref:`atlas-api-customDatabaseRoles-getCustomDatabaseRole` - Returns one custom role for the specified project. -* :ref:`atlas-api-customDatabaseRoles-listCustomDatabaseRoles` - Returns all custom roles for the specified project. -* :ref:`atlas-api-customDatabaseRoles-updateCustomDatabaseRole` - Updates one custom role in the specified project. +* :ref:`atlas-api-customDatabaseRoles-createCustomDatabaseRole` - experimental: Creates one custom role in the specified project. +* :ref:`atlas-api-customDatabaseRoles-deleteCustomDatabaseRole` - experimental: Removes one custom role from the specified project. +* :ref:`atlas-api-customDatabaseRoles-getCustomDatabaseRole` - experimental: Returns one custom role for the specified project. +* :ref:`atlas-api-customDatabaseRoles-listCustomDatabaseRoles` - experimental: Returns all custom roles for the specified project. +* :ref:`atlas-api-customDatabaseRoles-updateCustomDatabaseRole` - experimental: 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 69b8d44eaf..aa41b290d4 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 -Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. +experimental: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. us-east-1 is com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4. us-west-1 is com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb. eu-west-1 is com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e. eu-west-2 is com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9. eu-central-1 is com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d. sa-east-1 is com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044. ap-southeast-2 is com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e. ap-south-1 is com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'createDataFederationPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createDataFederationPrivateEndpoint diff --git a/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt index 05b7ee8168..7a44f3faf8 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 -Creates one federated database instance in the specified project. +experimental: Creates one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'createFederatedDatabase'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createFederatedDatabase diff --git a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt b/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt index 64293348c2..f44741697b 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 -Creates or updates one query limit for one federated database instance. +experimental: Creates or updates one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createOneDataFederationQueryLimit'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createOneDataFederationQueryLimit diff --git a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt index 7a36c3ef9f..69e5a044a4 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 -Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. +experimental: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteDataFederationPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteDataFederationPrivateEndpoint diff --git a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt index 29a7ed07b6..da4f00841d 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 -Removes one federated database instance from the specified project. +experimental: Removes one federated database instance from the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'deleteFederatedDatabase'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteFederatedDatabase diff --git a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt b/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt index 8f35821855..32bf86bd10 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 -Deletes one query limit for one federated database instance. +experimental: Deletes one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteOneDataFederationInstanceQueryLimit'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteOneDataFederationInstanceQueryLimit diff --git a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt b/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt index a77c2d2574..9ce01c274c 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 -Downloads the query logs for the specified federated database instance. +experimental: Downloads the query logs for the specified federated database instance. To use this resource, the requesting API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". This command is invoking the endpoint with OperationID: 'downloadFederatedDatabaseQueryLogs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadFederatedDatabaseQueryLogs diff --git a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt index e800cbf14f..baf836e668 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 -Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. +experimental: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'getDataFederationPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getDataFederationPrivateEndpoint diff --git a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt index 3cbfce739d..bfc23374ec 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 -Returns the details of one federated database instance within the specified project. +experimental: Returns the details of one federated database instance within the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'getFederatedDatabase'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getFederatedDatabase diff --git a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt b/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt index d29caa231f..9eb105e8b2 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 -Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. +experimental: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'listDataFederationPrivateEndpoints'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listDataFederationPrivateEndpoints diff --git a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt b/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt index 86b8d85945..c86fabb5e9 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 -Returns the details of all federated database instances in the specified project. +experimental: Returns the details of all federated database instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only or higher role. This command is invoking the endpoint with OperationID: 'listFederatedDatabases'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listFederatedDatabases diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt index 438c9e00ab..09444f7f6d 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 -Returns the details of one query limit for the specified federated database instance in the specified project. +experimental: Returns the details of one query limit for the specified federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'returnFederatedDatabaseQueryLimit'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimit diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt index ef9aaeb455..e36b65298d 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 -Returns query limits for a federated databases instance in the specified project. +experimental: Returns query limits for a federated databases instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'returnFederatedDatabaseQueryLimits'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimits diff --git a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt index 9857850e60..c068ac00ef 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 -Updates the details of one federated database instance in the specified project. +experimental: Updates the details of one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or higher role. This command is invoking the endpoint with OperationID: 'updateFederatedDatabase'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/updateFederatedDatabase diff --git a/docs/command/atlas-api-dataFederation.txt b/docs/command/atlas-api-dataFederation.txt index ec96ccbd6a..5fa532ec5c 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 -Returns, adds, edits, and removes Federated Database Instances. +experimental: 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 +51,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-dataFederation-createDataFederationPrivateEndpoint` - Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. -* :ref:`atlas-api-dataFederation-createFederatedDatabase` - Creates one federated database instance in the specified project. -* :ref:`atlas-api-dataFederation-createOneDataFederationQueryLimit` - Creates or updates one query limit for one federated database instance. -* :ref:`atlas-api-dataFederation-deleteDataFederationPrivateEndpoint` - Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-deleteFederatedDatabase` - Removes one federated database instance from the specified project. -* :ref:`atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit` - Deletes one query limit for one federated database instance. -* :ref:`atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs` - Downloads the query logs for the specified federated database instance. -* :ref:`atlas-api-dataFederation-getDataFederationPrivateEndpoint` - Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-getFederatedDatabase` - Returns the details of one federated database instance within the specified project. -* :ref:`atlas-api-dataFederation-listDataFederationPrivateEndpoints` - Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-listFederatedDatabases` - Returns the details of all federated database instances in the specified project. -* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimit` - Returns the details of one query limit for the specified federated database instance in the specified project. -* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimits` - Returns query limits for a federated databases instance in the specified project. -* :ref:`atlas-api-dataFederation-updateFederatedDatabase` - Updates the details of one federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-createDataFederationPrivateEndpoint` - experimental: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. +* :ref:`atlas-api-dataFederation-createFederatedDatabase` - experimental: Creates one federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-createOneDataFederationQueryLimit` - experimental: Creates or updates one query limit for one federated database instance. +* :ref:`atlas-api-dataFederation-deleteDataFederationPrivateEndpoint` - experimental: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-deleteFederatedDatabase` - experimental: Removes one federated database instance from the specified project. +* :ref:`atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit` - experimental: Deletes one query limit for one federated database instance. +* :ref:`atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs` - experimental: Downloads the query logs for the specified federated database instance. +* :ref:`atlas-api-dataFederation-getDataFederationPrivateEndpoint` - experimental: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-getFederatedDatabase` - experimental: Returns the details of one federated database instance within the specified project. +* :ref:`atlas-api-dataFederation-listDataFederationPrivateEndpoints` - experimental: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-listFederatedDatabases` - experimental: Returns the details of all federated database instances in the specified project. +* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimit` - experimental: Returns the details of one query limit for the specified federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimits` - experimental: Returns query limits for a federated databases instance in the specified project. +* :ref:`atlas-api-dataFederation-updateFederatedDatabase` - experimental: 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 eaa180cac1..935e861f1d 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 -Creates one Data Lake Pipeline. +experimental: Creates one Data Lake Pipeline. This command is invoking the endpoint with OperationID: 'createPipeline'. For more information about flags, format of --file and examples, see: 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 abfa3f349f..2d99cb82c2 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 -Removes one Data Lake Pipeline. +experimental: Removes one Data Lake Pipeline. This command is invoking the endpoint with OperationID: 'deletePipeline'. For more information about flags, format of --file and examples, see: 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 c0788355ca..b4bcf94eac 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 -Deletes dataset that Atlas generated during the specified pipeline run. +experimental: Deletes dataset that Atlas generated during the specified pipeline run. This command is invoking the endpoint with OperationID: 'deletePipelineRunDataset'. For more information about flags, format of --file and examples, see: 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 af774c9af4..21ed791a9f 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 -Returns the details of one Data Lake Pipeline within the specified project. +experimental: Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPipeline'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipeline diff --git a/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt b/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt index 0680a26646..8308ccda44 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 -Returns the details of one Data Lake Pipeline run within the specified project. +experimental: Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPipelineRun'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipelineRun diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt index 8817b44fa7..33eb90088a 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 -Returns a list of past Data Lake Pipeline runs. +experimental: Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPipelineRuns'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineRuns diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt index 480fc4c14c..76a4933433 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 -Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. +experimental: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPipelineSchedules'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSchedules diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt index 65d4c2e3fb..65d44c243e 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 -Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. +experimental: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPipelineSnapshots'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSnapshots diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelines.txt b/docs/command/atlas-api-dataLakePipelines-listPipelines.txt index fc8f2e9c2d..b56763f8a3 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 -Returns a list of Data Lake Pipelines. +experimental: Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPipelines'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelines diff --git a/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt b/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt index 3879c3d6a7..445983326f 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 -Pauses ingestion for a Data Lake Pipeline within the specified project. +experimental: Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'pausePipeline'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/pausePipeline diff --git a/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt b/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt index 9588f48dcb..f8f588c2ef 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 -Resumes ingestion for a Data Lake Pipeline within the specified project. +experimental: Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'resumePipeline'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/resumePipeline diff --git a/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt b/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt index 986c3b0791..8263fa74ae 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 -Triggers a Data Lake Pipeline ingestion of a specified snapshot. +experimental: Triggers a Data Lake Pipeline ingestion of a specified snapshot. This command is invoking the endpoint with OperationID: 'triggerSnapshotIngestion'. For more information about flags, format of --file and examples, see: 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 ec1b59f299..4c88b96e6d 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 -Updates one Data Lake Pipeline. +experimental: Updates one Data Lake Pipeline. This command is invoking the endpoint with OperationID: 'updatePipeline'. For more information about flags, format of --file and examples, see: 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 c2ef173688..c915c5a66e 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 -Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. +experimental: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. Options ------- @@ -49,19 +49,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-dataLakePipelines-createPipeline` - Creates one Data Lake Pipeline. -* :ref:`atlas-api-dataLakePipelines-deletePipeline` - Removes one Data Lake Pipeline. -* :ref:`atlas-api-dataLakePipelines-deletePipelineRunDataset` - Deletes dataset that Atlas generated during the specified pipeline run. -* :ref:`atlas-api-dataLakePipelines-getPipeline` - Returns the details of one Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-getPipelineRun` - Returns the details of one Data Lake Pipeline run within the specified project. -* :ref:`atlas-api-dataLakePipelines-listPipelineRuns` - Returns a list of past Data Lake Pipeline runs. -* :ref:`atlas-api-dataLakePipelines-listPipelineSchedules` - Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. -* :ref:`atlas-api-dataLakePipelines-listPipelineSnapshots` - Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. -* :ref:`atlas-api-dataLakePipelines-listPipelines` - Returns a list of Data Lake Pipelines. -* :ref:`atlas-api-dataLakePipelines-pausePipeline` - Pauses ingestion for a Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-resumePipeline` - Resumes ingestion for a Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-triggerSnapshotIngestion` - Triggers a Data Lake Pipeline ingestion of a specified snapshot. -* :ref:`atlas-api-dataLakePipelines-updatePipeline` - Updates one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-createPipeline` - experimental: Creates one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-deletePipeline` - experimental: Removes one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-deletePipelineRunDataset` - experimental: Deletes dataset that Atlas generated during the specified pipeline run. +* :ref:`atlas-api-dataLakePipelines-getPipeline` - experimental: Returns the details of one Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-getPipelineRun` - experimental: Returns the details of one Data Lake Pipeline run within the specified project. +* :ref:`atlas-api-dataLakePipelines-listPipelineRuns` - experimental: Returns a list of past Data Lake Pipeline runs. +* :ref:`atlas-api-dataLakePipelines-listPipelineSchedules` - experimental: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. +* :ref:`atlas-api-dataLakePipelines-listPipelineSnapshots` - experimental: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. +* :ref:`atlas-api-dataLakePipelines-listPipelines` - experimental: Returns a list of Data Lake Pipelines. +* :ref:`atlas-api-dataLakePipelines-pausePipeline` - experimental: Pauses ingestion for a Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-resumePipeline` - experimental: Resumes ingestion for a Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-triggerSnapshotIngestion` - experimental: Triggers a Data Lake Pipeline ingestion of a specified snapshot. +* :ref:`atlas-api-dataLakePipelines-updatePipeline` - experimental: 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 3e2b2a9451..7c910f209c 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 -Creates one database user in the specified project. +experimental: 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 API Key must have the Project Owner or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'createDatabaseUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/createDatabaseUser diff --git a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt index 4b349fa8ba..c35aed78f5 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 -Removes one database user from the specified project. +experimental: Removes one database user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteDatabaseUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/deleteDatabaseUser diff --git a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt index 775a128454..c78a436472 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 -Returns one database user that belong to the specified project. +experimental: Returns one database user that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getDatabaseUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/getDatabaseUser diff --git a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt index ac59198ac8..fc1000890b 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 -Returns all database users that belong to the specified project. +experimental: Returns all database users that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listDatabaseUsers'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/listDatabaseUsers diff --git a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt index 67dad18765..166a594f4f 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 -Updates one database user that belongs to the specified project. +experimental: Updates one database user that belongs to the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'updateDatabaseUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/updateDatabaseUser diff --git a/docs/command/atlas-api-databaseUsers.txt b/docs/command/atlas-api-databaseUsers.txt index 9c0ff4fef9..1d0b68ec27 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 -Returns, adds, edits, and removes database users. +experimental: Returns, adds, edits, and removes database users. Options ------- @@ -49,11 +49,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-databaseUsers-createDatabaseUser` - Creates one database user in the specified project. -* :ref:`atlas-api-databaseUsers-deleteDatabaseUser` - Removes one database user from the specified project. -* :ref:`atlas-api-databaseUsers-getDatabaseUser` - Returns one database user that belong to the specified project. -* :ref:`atlas-api-databaseUsers-listDatabaseUsers` - Returns all database users that belong to the specified project. -* :ref:`atlas-api-databaseUsers-updateDatabaseUser` - Updates one database user that belongs to the specified project. +* :ref:`atlas-api-databaseUsers-createDatabaseUser` - experimental: Creates one database user in the specified project. +* :ref:`atlas-api-databaseUsers-deleteDatabaseUser` - experimental: Removes one database user from the specified project. +* :ref:`atlas-api-databaseUsers-getDatabaseUser` - experimental: Returns one database user that belong to the specified project. +* :ref:`atlas-api-databaseUsers-listDatabaseUsers` - experimental: Returns all database users that belong to the specified project. +* :ref:`atlas-api-databaseUsers-updateDatabaseUser` - experimental: 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 d532ca57f5..5c076a45db 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 -Creates a private endpoint in the specified region for encryption at rest using customer key management. +experimental: Creates a private endpoint in the specified region for encryption at rest using customer key management. This command is invoking the endpoint with OperationID: 'createEncryptionAtRestPrivateEndpoint'. For more information about flags, format of --file and examples, see: 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 26a15ec63d..aa13278174 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 -Returns the configuration for encryption at rest using the keys you manage through your cloud provider. +experimental: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Owner role. LIMITED TO M10 OR GREATER: MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater. This command is invoking the endpoint with OperationID: 'getEncryptionAtRest'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRest diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt index 9c8b846666..6fc409e7a1 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 -Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +experimental: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. This command is invoking the endpoint with OperationID: 'getEncryptionAtRestPrivateEndpoint'. For more information about flags, format of --file and examples, see: 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 bf3d1ad887..2590bb86cc 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 -Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. +experimental: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. This command is invoking the endpoint with OperationID: 'getEncryptionAtRestPrivateEndpointsForCloudProvider'. For more information about flags, format of --file and examples, see: 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 f5c23e2599..2356e35e50 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 -Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +experimental: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. This command is invoking the endpoint with OperationID: 'requestEncryptionAtRestPrivateEndpointDeletion'. For more information about flags, format of --file and examples, see: 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 32cda7a3f5..1abffd435c 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 -Updates the configuration for encryption at rest using the keys you manage through your cloud provider. +experimental: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Owner role. This feature isn't available for M0 free clusters, M2, M5, or serverless clusters. After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management. This command is invoking the endpoint with OperationID: 'updateEncryptionAtRest'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/updateEncryptionAtRest diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt index 389cb1e029..a59b15999c 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 -Returns and edits the Encryption at Rest using Customer Key Management configuration. +experimental: 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 +51,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint` - Creates a private endpoint in the specified region for encryption at rest using customer key management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest` - Returns the configuration for encryption at rest using the keys you manage through your cloud provider. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint` - Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider` - Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion` - Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest` - Updates the configuration for encryption at rest using the keys you manage through your cloud provider. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint` - experimental: Creates a private endpoint in the specified region for encryption at rest using customer key management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest` - experimental: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint` - experimental: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider` - experimental: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion` - experimental: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest` - experimental: 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 4230b34dfe..3bad4bb161 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 -Returns one event for the specified organization. +experimental: Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'getOrganizationEvent'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getOrganizationEvent diff --git a/docs/command/atlas-api-events-getProjectEvent.txt b/docs/command/atlas-api-events-getProjectEvent.txt index 04bca695c7..35ee917ee2 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 -Returns one event for the specified project. +experimental: Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'getProjectEvent'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getProjectEvent diff --git a/docs/command/atlas-api-events-listEventTypes.txt b/docs/command/atlas-api-events-listEventTypes.txt index 18f9c4002e..bbd18da9da 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 -Returns a list of all event types, along with a description and additional metadata about each event. +experimental: Returns a list of all event types, along with a description and additional metadata about each event. This command is invoking the endpoint with OperationID: 'listEventTypes'. For more information about flags, format of --file and examples, see: 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 1204ce964b..58b43eec89 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 -Returns all events for the specified organization. +experimental: Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listOrganizationEvents'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrganizationEvents diff --git a/docs/command/atlas-api-events-listProjectEvents.txt b/docs/command/atlas-api-events-listProjectEvents.txt index a34330c5b4..1dae369085 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 -Returns all events for the specified project. +experimental: Returns all events for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listProjectEvents'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listProjectEvents diff --git a/docs/command/atlas-api-events.txt b/docs/command/atlas-api-events.txt index 69a32e57be..1a952b87a7 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 -Returns events. +experimental: Returns events. This collection remains under revision and may change. @@ -51,11 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-events-getOrganizationEvent` - Returns one event for the specified organization. -* :ref:`atlas-api-events-getProjectEvent` - Returns one event for the specified project. -* :ref:`atlas-api-events-listEventTypes` - Returns a list of all event types, along with a description and additional metadata about each event. -* :ref:`atlas-api-events-listOrganizationEvents` - Returns all events for the specified organization. -* :ref:`atlas-api-events-listProjectEvents` - Returns all events for the specified project. +* :ref:`atlas-api-events-getOrganizationEvent` - experimental: Returns one event for the specified organization. +* :ref:`atlas-api-events-getProjectEvent` - experimental: Returns one event for the specified project. +* :ref:`atlas-api-events-listEventTypes` - experimental: Returns a list of all event types, along with a description and additional metadata about each event. +* :ref:`atlas-api-events-listOrganizationEvents` - experimental: Returns all events for the specified organization. +* :ref:`atlas-api-events-listProjectEvents` - experimental: 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 b89962fed4..d2fd1a36c6 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 -Creates one identity provider within the specified federation. +experimental: Creates one identity provider within the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. Note: This resource only supports the creation of OIDC identity providers. This command is invoking the endpoint with OperationID: 'createIdentityProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createIdentityProvider diff --git a/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt index cc18383256..c12aad1dde 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 -Adds one role mapping to the specified organization in the specified federation. +experimental: Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'createRoleMapping'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createRoleMapping diff --git a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt b/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt index a9d242b722..192078b37b 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 -Deletes the federation settings instance and all associated data, including identity providers and domains. +experimental: Deletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting API Key must have the Organization Owner role in the last remaining connected organization. Note: requests to this resource will fail if there is more than one connected organization in the federation. This command is invoking the endpoint with OperationID: 'deleteFederationApp'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationApp diff --git a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt index 8073cf0e8f..c67c3fc303 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 -Deletes one identity provider in the specified federation. +experimental: Deletes one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. Note: Requests to this resource will fail if the identity provider has any connected organizations. Before deleting an identity provider, disconnect all organizations and confirm that no organization in your account uses this identity provider. To learn more, see Manage Organization Mapping for Federated Authentication. This command is invoking the endpoint with OperationID: 'deleteIdentityProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteIdentityProvider diff --git a/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt index 94e335a2ac..e611e99175 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 -Removes one role mapping in the specified organization from the specified federation. +experimental: Removes one role mapping in the specified organization from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'deleteRoleMapping'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteRoleMapping diff --git a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt index d285a124cc..a493e8d603 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 -Returns the specified connected org config from the specified federation. +experimental: Returns the specified connected org config from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. This command is invoking the endpoint with OperationID: 'getConnectedOrgConfig'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getConnectedOrgConfig diff --git a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt index 759892a956..1e751e8abe 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 -Returns information about the federation settings for the specified organization. +experimental: Returns information about the federation settings for the specified organization. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. This command is invoking the endpoint with OperationID: 'getFederationSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettings diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt index 388d85626f..46febd4dcf 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 -Returns one identity provider in the specified federation by the identity provider's id. +experimental: Returns one identity provider in the specified federation by the identity provider's id. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. This command is invoking the endpoint with OperationID: 'getIdentityProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProvider diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt index b0e955ba8a..8fb305313c 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 -Returns the metadata of one identity provider in the specified federation. +experimental: Returns the metadata of one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. This command is invoking the endpoint with OperationID: 'getIdentityProviderMetadata'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProviderMetadata diff --git a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt index 967afab2d1..5efb5b6e38 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 -Returns one role mapping from the specified organization in the specified federation. +experimental: Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'getRoleMapping'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getRoleMapping diff --git a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt index ad1b1f304e..075eaaf12b 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 -Returns all connected org configs in the specified federation. +experimental: Returns all connected org configs in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected orgs. This command is invoking the endpoint with OperationID: 'listConnectedOrgConfigs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listConnectedOrgConfigs diff --git a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt index 170db9a245..8fc4a3f897 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 -Returns all identity providers with the provided protocol and type in the specified federation. +experimental: Returns all identity providers with the provided protocol and type in the specified federation. If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. This command is invoking the endpoint with OperationID: 'listIdentityProviders'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listIdentityProviders diff --git a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt index 907ce0bc9d..4502ee3da9 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 -Returns all role mappings from the specified organization in the specified federation. +experimental: Returns all role mappings from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'listRoleMappings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listRoleMappings diff --git a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt index da3fc29bbd..440dded3a6 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 -Removes one connected organization configuration from the specified federation. +experimental: Removes one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation. This command is invoking the endpoint with OperationID: 'removeConnectedOrgConfig'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/removeConnectedOrgConfig diff --git a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt index a228020791..f779d32b7b 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 -Revokes the JWKS tokens from the requested OIDC identity provider. +experimental: Revokes the JWKS tokens from the requested OIDC identity provider. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. Note: Revoking your JWKS tokens immediately refreshes your IdP public keys from all your Atlas clusters, invalidating previously signed access tokens and logging out all users. You may need to restart your MongoDB clients. All organizations connected to the identity provider will be affected. To learn more, see Configure OIDC Authorization. This command is invoking the endpoint with OperationID: 'revokeJwksFromIdentityProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/revokeJwksFromIdentityProvider diff --git a/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt index 8fa57b89dc..8a92e09a7b 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 -Updates one connected organization configuration from the specified federation. +experimental: Updates one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. Note If the organization configuration has no associated identity provider, you can't use this resource to update role mappings or post authorization role grants. Note: The domainRestrictionEnabled field defaults to false if not provided in the request. Note: If the identityProviderId field is not provided, you will disconnect the organization and the identity provider. Note: Currently connected data access identity providers missing from the dataAccessIdentityProviderIds field will be disconnected. This command is invoking the endpoint with OperationID: 'updateConnectedOrgConfig'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig diff --git a/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt index b1b033340f..be3657d908 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 -Updates one identity provider in the specified federation. +experimental: Updates one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. Note: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database. This command is invoking the endpoint with OperationID: 'updateIdentityProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateIdentityProvider diff --git a/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt index fb20f2357e..eea4b15ead 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 -Updates one role mapping in the specified organization in the specified federation. +experimental: Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'updateRoleMapping'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateRoleMapping diff --git a/docs/command/atlas-api-federatedAuthentication.txt b/docs/command/atlas-api-federatedAuthentication.txt index adb0fbbbec..ac45a2f7c5 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 -Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. +experimental: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. Options ------- @@ -49,24 +49,24 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-federatedAuthentication-createIdentityProvider` - Creates one identity provider within the specified federation. -* :ref:`atlas-api-federatedAuthentication-createRoleMapping` - Adds one role mapping to the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-deleteFederationApp` - Deletes the federation settings instance and all associated data, including identity providers and domains. -* :ref:`atlas-api-federatedAuthentication-deleteIdentityProvider` - Deletes one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-deleteRoleMapping` - Removes one role mapping in the specified organization from the specified federation. -* :ref:`atlas-api-federatedAuthentication-getConnectedOrgConfig` - Returns the specified connected org config from the specified federation. -* :ref:`atlas-api-federatedAuthentication-getFederationSettings` - Returns information about the federation settings for the specified organization. -* :ref:`atlas-api-federatedAuthentication-getIdentityProvider` - Returns one identity provider in the specified federation by the identity provider's id. -* :ref:`atlas-api-federatedAuthentication-getIdentityProviderMetadata` - Returns the metadata of one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-getRoleMapping` - Returns one role mapping from the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listConnectedOrgConfigs` - Returns all connected org configs in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listIdentityProviders` - Returns all identity providers with the provided protocol and type in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listRoleMappings` - Returns all role mappings from the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-removeConnectedOrgConfig` - Removes one connected organization configuration from the specified federation. -* :ref:`atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider` - Revokes the JWKS tokens from the requested OIDC identity provider. -* :ref:`atlas-api-federatedAuthentication-updateConnectedOrgConfig` - Updates one connected organization configuration from the specified federation. -* :ref:`atlas-api-federatedAuthentication-updateIdentityProvider` - Updates one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-updateRoleMapping` - Updates one role mapping in the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-createIdentityProvider` - experimental: Creates one identity provider within the specified federation. +* :ref:`atlas-api-federatedAuthentication-createRoleMapping` - experimental: Adds one role mapping to the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-deleteFederationApp` - experimental: Deletes the federation settings instance and all associated data, including identity providers and domains. +* :ref:`atlas-api-federatedAuthentication-deleteIdentityProvider` - experimental: Deletes one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-deleteRoleMapping` - experimental: Removes one role mapping in the specified organization from the specified federation. +* :ref:`atlas-api-federatedAuthentication-getConnectedOrgConfig` - experimental: Returns the specified connected org config from the specified federation. +* :ref:`atlas-api-federatedAuthentication-getFederationSettings` - experimental: Returns information about the federation settings for the specified organization. +* :ref:`atlas-api-federatedAuthentication-getIdentityProvider` - experimental: Returns one identity provider in the specified federation by the identity provider's id. +* :ref:`atlas-api-federatedAuthentication-getIdentityProviderMetadata` - experimental: Returns the metadata of one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-getRoleMapping` - experimental: Returns one role mapping from the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listConnectedOrgConfigs` - experimental: Returns all connected org configs in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listIdentityProviders` - experimental: Returns all identity providers with the provided protocol and type in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listRoleMappings` - experimental: Returns all role mappings from the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-removeConnectedOrgConfig` - experimental: Removes one connected organization configuration from the specified federation. +* :ref:`atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider` - experimental: Revokes the JWKS tokens from the requested OIDC identity provider. +* :ref:`atlas-api-federatedAuthentication-updateConnectedOrgConfig` - experimental: Updates one connected organization configuration from the specified federation. +* :ref:`atlas-api-federatedAuthentication-updateIdentityProvider` - experimental: Updates one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-updateRoleMapping` - experimental: 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 360f6395ce..943dd8b253 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 -Creates one flex cluster in the specified project. +experimental: Creates one flex cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createFlexCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster diff --git a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt index 1415ac51b8..6f2350d913 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 -Removes one flex cluster from the specified project. +experimental: Removes one flex cluster from the specified project. The flex cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteFlexCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster diff --git a/docs/command/atlas-api-flexClusters-getFlexCluster.txt b/docs/command/atlas-api-flexClusters-getFlexCluster.txt index 351ca95299..d2f7030ef9 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 -Returns details for one flex cluster in the specified project. +experimental: Returns details for one flex cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getFlexCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster diff --git a/docs/command/atlas-api-flexClusters-listFlexClusters.txt b/docs/command/atlas-api-flexClusters-listFlexClusters.txt index 3ffca27f35..61358c523d 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 -Returns details for all flex clusters in the specified project. +experimental: Returns details for all flex clusters in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listFlexClusters'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters diff --git a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt index 7db082f62f..b54cda9102 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 -Updates one flex cluster in the specified project. +experimental: Updates one flex cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateFlexCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateFlexCluster diff --git a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt b/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt index 1a39623932..4100015281 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 -Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. +experimental: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. This command is invoking the endpoint with OperationID: 'upgradeFlexCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster diff --git a/docs/command/atlas-api-flexClusters.txt b/docs/command/atlas-api-flexClusters.txt index 2ecadeb598..15194b8538 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 -Returns, adds, edits, and removes flex clusters. +experimental: Returns, adds, edits, and removes flex clusters. Options ------- @@ -49,12 +49,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexClusters-createFlexCluster` - Creates one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-deleteFlexCluster` - Removes one flex cluster from the specified project. -* :ref:`atlas-api-flexClusters-getFlexCluster` - Returns details for one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-listFlexClusters` - Returns details for all flex clusters in the specified project. -* :ref:`atlas-api-flexClusters-updateFlexCluster` - Updates one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-upgradeFlexCluster` - Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. +* :ref:`atlas-api-flexClusters-createFlexCluster` - experimental: Creates one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-deleteFlexCluster` - experimental: Removes one flex cluster from the specified project. +* :ref:`atlas-api-flexClusters-getFlexCluster` - experimental: Returns details for one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-listFlexClusters` - experimental: Returns details for all flex clusters in the specified project. +* :ref:`atlas-api-flexClusters-updateFlexCluster` - experimental: Updates one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-upgradeFlexCluster` - experimental: 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 a1f2d48b96..3695cdcd1a 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 -Restores one snapshot of one flex cluster from the specified project. +experimental: Restores one snapshot of one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createFlexBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob diff --git a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt index 05ddece84c..5d98215676 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 -Returns one restore job for one flex cluster from the specified project. +experimental: Returns one restore job for one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getFlexBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob diff --git a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt index 285abb8add..cb8e3e28c2 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 -Returns all restore jobs for one flex cluster from the specified project. +experimental: Returns all restore jobs for one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'listFlexBackupRestoreJobs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs diff --git a/docs/command/atlas-api-flexRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs.txt index 6af27fc245..c48686273f 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 -Returns and adds restore jobs for flex database deployments. +experimental: Returns and adds restore jobs for flex database deployments. Options ------- @@ -49,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexRestoreJobs-createFlexBackupRestoreJob` - Restores one snapshot of one flex cluster from the specified project. -* :ref:`atlas-api-flexRestoreJobs-getFlexBackupRestoreJob` - Returns one restore job for one flex cluster from the specified project. -* :ref:`atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs` - Returns all restore jobs for one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-createFlexBackupRestoreJob` - experimental: Restores one snapshot of one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-getFlexBackupRestoreJob` - experimental: Returns one restore job for one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs` - experimental: 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 07eda88a22..19cee83f42 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 -Requests one snapshot for the specified flex cluster. +experimental: Requests one snapshot for the specified flex cluster. This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'downloadFlexBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup diff --git a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt b/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt index 59118b2a67..4dedea1c54 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 -Returns one snapshot of one flex cluster from the specified project. +experimental: Returns one snapshot of one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getFlexBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup diff --git a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt b/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt index 74ae9269ec..5703f49777 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 -Returns all snapshots of one flex cluster from the specified project. +experimental: Returns all snapshots of one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listFlexBackups'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups diff --git a/docs/command/atlas-api-flexSnapshots.txt b/docs/command/atlas-api-flexSnapshots.txt index 7c6cf6a961..4c7d5f9695 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 -Returns and requests to download flex database deployment snapshots. +experimental: Returns and requests to download flex database deployment snapshots. Options ------- @@ -49,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexSnapshots-downloadFlexBackup` - Requests one snapshot for the specified flex cluster. -* :ref:`atlas-api-flexSnapshots-getFlexBackup` - Returns one snapshot of one flex cluster from the specified project. -* :ref:`atlas-api-flexSnapshots-listFlexBackups` - Returns all snapshots of one flex cluster from the specified project. +* :ref:`atlas-api-flexSnapshots-downloadFlexBackup` - experimental: Requests one snapshot for the specified flex cluster. +* :ref:`atlas-api-flexSnapshots-getFlexBackup` - experimental: Returns one snapshot of one flex cluster from the specified project. +* :ref:`atlas-api-flexSnapshots-listFlexBackups` - experimental: 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 5178c22e2c..7e2a341ef8 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 -Creates one custom zone mapping for the specified global cluster. +experimental: Creates one custom zone mapping for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createCustomZoneMapping'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createCustomZoneMapping diff --git a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt index 1c1f3c3b70..27b8408ba5 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 -Creates one managed namespace within the specified global cluster. +experimental: Creates one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'createManagedNamespace'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createManagedNamespace diff --git a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt b/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt index 9d99868371..483fd7a08a 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 -Removes all custom zone mappings for the specified global cluster. +experimental: Removes all custom zone mappings for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteAllCustomZoneMappings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteAllCustomZoneMappings diff --git a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt b/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt index b4013424af..5fe50fff3f 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 -Removes one managed namespace within the specified global cluster. +experimental: Removes one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'deleteManagedNamespace'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteManagedNamespace diff --git a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt b/docs/command/atlas-api-globalClusters-getManagedNamespace.txt index 48fde4e4b7..66a44601c5 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 -Returns one managed namespace within the specified global cluster. +experimental: Returns one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getManagedNamespace'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/getManagedNamespace diff --git a/docs/command/atlas-api-globalClusters.txt b/docs/command/atlas-api-globalClusters.txt index dfca0d2b7c..2473280899 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 -Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. +experimental: 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. @@ -51,11 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-globalClusters-createCustomZoneMapping` - Creates one custom zone mapping for the specified global cluster. -* :ref:`atlas-api-globalClusters-createManagedNamespace` - Creates one managed namespace within the specified global cluster. -* :ref:`atlas-api-globalClusters-deleteAllCustomZoneMappings` - Removes all custom zone mappings for the specified global cluster. -* :ref:`atlas-api-globalClusters-deleteManagedNamespace` - Removes one managed namespace within the specified global cluster. -* :ref:`atlas-api-globalClusters-getManagedNamespace` - Returns one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-createCustomZoneMapping` - experimental: Creates one custom zone mapping for the specified global cluster. +* :ref:`atlas-api-globalClusters-createManagedNamespace` - experimental: Creates one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-deleteAllCustomZoneMappings` - experimental: Removes all custom zone mappings for the specified global cluster. +* :ref:`atlas-api-globalClusters-deleteManagedNamespace` - experimental: Removes one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-getManagedNamespace` - experimental: 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 3be185d214..0d440e0860 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 -Creates a query process within the Cost Explorer for the given parameters. +experimental: 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. This command is invoking the endpoint with OperationID: 'createCostExplorerQueryProcess'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/createCostExplorerQueryProcess diff --git a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt b/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt index 1e0490340d..d32d7c9bf7 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 -Returns one invoice that MongoDB issued to the specified organization in CSV format. +experimental: Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role. 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. This command is invoking the endpoint with OperationID: 'downloadInvoiceCsv'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/downloadInvoiceCsv diff --git a/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt b/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt index 70fe0506d4..0d2284b263 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 -Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. +experimental: 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. This command is invoking the endpoint with OperationID: 'getCostExplorerQueryProcess'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getCostExplorerQueryProcess diff --git a/docs/command/atlas-api-invoices-getInvoice.txt b/docs/command/atlas-api-invoices-getInvoice.txt index ae38f48ced..a09f2fc6f5 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 -Returns one invoice that MongoDB issued to the specified organization. +experimental: Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner role. 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. This command is invoking the endpoint with OperationID: 'getInvoice'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getInvoice diff --git a/docs/command/atlas-api-invoices-listInvoices.txt b/docs/command/atlas-api-invoices-listInvoices.txt index 5faf5cee57..d7e7646ac8 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 -Returns all invoices that MongoDB issued to the specified organization. +experimental: Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner role. 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. This command is invoking the endpoint with OperationID: 'listInvoices'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listInvoices diff --git a/docs/command/atlas-api-invoices-listPendingInvoices.txt b/docs/command/atlas-api-invoices-listPendingInvoices.txt index f582c8f12b..9b51624d0a 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 -Returns all invoices accruing charges for the current billing cycle for the specified organization. +experimental: Returns all invoices accruing charges for the current billing cycle for the specified organization. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. This command is invoking the endpoint with OperationID: 'listPendingInvoices'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listPendingInvoices diff --git a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt b/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt index 8793e42ab6..7ed4d103b7 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 -Query the lineItems of the specified invoice and return the result JSON. +experimental: Query the lineItems of the specified invoice and return the result JSON. A unique 24-hexadecimal digit string identifies the invoice. This command is invoking the endpoint with OperationID: 'queryLineItemsFromSingleInvoice'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/queryLineItemsFromSingleInvoice diff --git a/docs/command/atlas-api-invoices.txt b/docs/command/atlas-api-invoices.txt index 85b96b9aa9..36ce597361 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 -Returns invoices. +experimental: Returns invoices. Options ------- @@ -49,13 +49,13 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-invoices-createCostExplorerQueryProcess` - Creates a query process within the Cost Explorer for the given parameters. -* :ref:`atlas-api-invoices-downloadInvoiceCsv` - Returns one invoice that MongoDB issued to the specified organization in CSV format. -* :ref:`atlas-api-invoices-getCostExplorerQueryProcess` - Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. -* :ref:`atlas-api-invoices-getInvoice` - Returns one invoice that MongoDB issued to the specified organization. -* :ref:`atlas-api-invoices-listInvoices` - Returns all invoices that MongoDB issued to the specified organization. -* :ref:`atlas-api-invoices-listPendingInvoices` - Returns all invoices accruing charges for the current billing cycle for the specified organization. -* :ref:`atlas-api-invoices-queryLineItemsFromSingleInvoice` - Query the lineItems of the specified invoice and return the result JSON. +* :ref:`atlas-api-invoices-createCostExplorerQueryProcess` - experimental: Creates a query process within the Cost Explorer for the given parameters. +* :ref:`atlas-api-invoices-downloadInvoiceCsv` - experimental: Returns one invoice that MongoDB issued to the specified organization in CSV format. +* :ref:`atlas-api-invoices-getCostExplorerQueryProcess` - experimental: 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` - experimental: Returns one invoice that MongoDB issued to the specified organization. +* :ref:`atlas-api-invoices-listInvoices` - experimental: Returns all invoices that MongoDB issued to the specified organization. +* :ref:`atlas-api-invoices-listPendingInvoices` - experimental: Returns all invoices accruing charges for the current billing cycle for the specified organization. +* :ref:`atlas-api-invoices-queryLineItemsFromSingleInvoice` - experimental: 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 f275252156..4160bf1e59 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 -Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. +experimental: Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteLdapConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/deleteLdapConfiguration diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt index 85acf172c8..f1e4b505dc 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 -Returns the current LDAP configuration for the specified project. +experimental: Returns the current LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getLdapConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfiguration diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt index 2de1f0d4db..1f525e6b00 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 -Returns the status of one request to verify one LDAP configuration for the specified project. +experimental: Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getLdapConfigurationStatus'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfigurationStatus diff --git a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt index ed17a01d2c..2c2cd2a77a 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 -Edits the LDAP configuration for the specified project. +experimental: Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. Updating this configuration triggers a rolling restart of the database. This command is invoking the endpoint with OperationID: 'saveLdapConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/saveLdapConfiguration diff --git a/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt index 5461bfce0c..2bbfbb7afd 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 -Verifies the LDAP configuration for the specified project. +experimental: Verifies the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'verifyLdapConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/verifyLdapConfiguration diff --git a/docs/command/atlas-api-ldapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration.txt index dc6199e1bb..237cd8960f 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 -Returns, edits, verifies, and removes LDAP configurations. +experimental: 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 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-ldapConfiguration-deleteLdapConfiguration` - Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-getLdapConfiguration` - Returns the current LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-getLdapConfigurationStatus` - Returns the status of one request to verify one LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-saveLdapConfiguration` - Edits the LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-verifyLdapConfiguration` - Verifies the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-deleteLdapConfiguration` - experimental: 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` - experimental: Returns the current LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-getLdapConfigurationStatus` - experimental: Returns the status of one request to verify one LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-saveLdapConfiguration` - experimental: Edits the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-verifyLdapConfiguration` - experimental: 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 bf59ae13b8..1e863f6592 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 -Restores one legacy backup for one cluster in the specified project. +experimental: Restores one legacy backup for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying delivery.methodName of AUTOMATED_RESTORE in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. This command is invoking the endpoint with OperationID: 'createLegacyBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/createLegacyBackupRestoreJob diff --git a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt index 24049a74b0..22c89373c7 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 -Removes one legacy backup snapshot for one cluster in the specified project. +experimental: Removes one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'deleteLegacySnapshot'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/deleteLegacySnapshot diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt index acfb4f05ee..18dcce015a 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 -Returns one legacy backup checkpoint for one cluster in the specified project. +experimental: Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getLegacyBackupCheckpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupCheckpoint diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt index 6efa53e01f..aa8af4bea4 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 -Returns one legacy backup restore job for one cluster in the specified project. +experimental: Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'getLegacyBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupRestoreJob diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt index 1c90446488..bb1755fe63 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 -Returns one legacy backup snapshot for one cluster in the specified project. +experimental: Returns one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'getLegacySnapshot'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshot diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt index f80a0858f3..5e681df8d5 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 -Returns the snapshot schedule for one cluster in the specified project. +experimental: Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'getLegacySnapshotSchedule'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshotSchedule diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt index 743427603a..7c3f499af0 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 -Returns all legacy backup checkpoints for one cluster in the specified project. +experimental: Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listLegacyBackupCheckpoints'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupCheckpoints diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt index 52573ea1bc..a23cfb0301 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 -Returns all legacy backup restore jobs for one cluster in the specified project. +experimental: Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. If you use the BATCH-ID query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set. This command is invoking the endpoint with OperationID: 'listLegacyBackupRestoreJobs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupRestoreJobs diff --git a/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt b/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt index 306a999967..e949aee054 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 -Returns all legacy backup snapshots for one cluster in the specified project. +experimental: Returns all legacy backup snapshots for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'listLegacySnapshots'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacySnapshots diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt index bc80cb541c..73c7a430de 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 -Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. +experimental: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'updateLegacySnapshotRetention'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotRetention diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt index 8b4638bda9..40e67afff0 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 -Updates the snapshot schedule for one cluster in the specified project. +experimental: Updates the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'updateLegacySnapshotSchedule'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotSchedule diff --git a/docs/command/atlas-api-legacyBackup.txt b/docs/command/atlas-api-legacyBackup.txt index 36acd1d547..b68d9fe064 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 -Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. +experimental: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. Options ------- @@ -49,17 +49,17 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-legacyBackup-createLegacyBackupRestoreJob` - Restores one legacy backup for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-deleteLegacySnapshot` - Removes one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacyBackupCheckpoint` - Returns one legacy backup checkpoint for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacyBackupRestoreJob` - Returns one legacy backup restore job for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacySnapshot` - Returns one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacySnapshotSchedule` - Returns the snapshot schedule for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacyBackupCheckpoints` - Returns all legacy backup checkpoints for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacyBackupRestoreJobs` - Returns all legacy backup restore jobs for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacySnapshots` - Returns all legacy backup snapshots for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-updateLegacySnapshotRetention` - Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-updateLegacySnapshotSchedule` - Updates the snapshot schedule for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-createLegacyBackupRestoreJob` - experimental: Restores one legacy backup for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-deleteLegacySnapshot` - experimental: Removes one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacyBackupCheckpoint` - experimental: Returns one legacy backup checkpoint for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacyBackupRestoreJob` - experimental: Returns one legacy backup restore job for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacySnapshot` - experimental: Returns one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacySnapshotSchedule` - experimental: Returns the snapshot schedule for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacyBackupCheckpoints` - experimental: Returns all legacy backup checkpoints for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacyBackupRestoreJobs` - experimental: Returns all legacy backup restore jobs for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacySnapshots` - experimental: Returns all legacy backup snapshots for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-updateLegacySnapshotRetention` - experimental: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-updateLegacySnapshotSchedule` - experimental: 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 80c2f00547..e1b9900a34 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 -Defers the maintenance window for the specified project. +experimental: Defers the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deferMaintenanceWindow'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/deferMaintenanceWindow diff --git a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt index fb61c22118..139679b515 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 -Returns the maintenance window for the specified project. +experimental: Returns the maintenance window for the specified project. MongoDB Cloud starts those maintenance activities when needed. You can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getMaintenanceWindow'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/getMaintenanceWindow diff --git a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt index d2a5ddb0f6..ecfea43868 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 -Resets the maintenance window for the specified project. +experimental: Resets the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'resetMaintenanceWindow'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/resetMaintenanceWindow diff --git a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt index d9e451e28f..9f576c0735 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 -Toggles automatic deferral of the maintenance window for the specified project. +experimental: Toggles automatic deferral of the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'toggleMaintenanceAutoDefer'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/toggleMaintenanceAutoDefer diff --git a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt index 87cfcd4264..ed453a3a8c 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 -Updates the maintenance window for the specified project. +experimental: Updates the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateMaintenanceWindow'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/updateMaintenanceWindow diff --git a/docs/command/atlas-api-maintenanceWindows.txt b/docs/command/atlas-api-maintenanceWindows.txt index e8b8e09988..a3260a6265 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 -Returns, edits, and removes maintenance windows. +experimental: 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 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-maintenanceWindows-deferMaintenanceWindow` - Defers the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-getMaintenanceWindow` - Returns the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-resetMaintenanceWindow` - Resets the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer` - Toggles automatic deferral of the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-updateMaintenanceWindow` - Updates the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-deferMaintenanceWindow` - experimental: Defers the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-getMaintenanceWindow` - experimental: Returns the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-resetMaintenanceWindow` - experimental: Resets the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer` - experimental: Toggles automatic deferral of the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-updateMaintenanceWindow` - experimental: 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 a15c9617c5..8e07a06224 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 -Adds one organization-level role to the MongoDB Cloud user. +experimental: Adds one organization-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role. Note: This operation is atomic. Note: This resource cannot be used to add a role to users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'addOrganizationRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addOrganizationRole diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt index e227000254..6c38685a8c 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 -Adds one project-level role to the MongoDB Cloud user. +experimental: 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 API Key must have the Project Owner role. Note: This resource cannot be used to add a role to users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'addProjectRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectRole diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt index 980e022b59..b89de7c2af 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 -Adds one MongoDB Cloud user to one project. +experimental: Adds one MongoDB Cloud user to one project. To use this resource, the requesting API Key must have the Group User Admin role. If the user has a pending invitation to join the project's organization, MongoDB Cloud modifies it and grants project access. If the user doesn't have an invitation to join the organization, MongoDB Cloud sends a new invitation that grants the user organization and project access. If the user is already active in the project's organization, MongoDB Cloud grants access to the project. This command is invoking the endpoint with OperationID: 'addProjectUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt b/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt index 3535756bea..0fe410fbea 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 -Adds one MongoDB Cloud user to one team. +experimental: 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 API Key must have the Organization Owner role. Note: This resource cannot be used to add a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'addUserToTeam'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addUserToTeam diff --git a/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt index 34d3333126..309e8fa871 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 -Invites one new or existing MongoDB Cloud user to join the organization. +experimental: Invites one new or existing MongoDB Cloud user to join the organization. The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting API Key must have the Organization Owner role. Note: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization. This command is invoking the endpoint with OperationID: 'createOrganizationUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createOrganizationUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt index 1617216fbd..2d0cd525f8 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 -Creates one MongoDB Cloud user account. +experimental: Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days. MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization. To use this resource, the requesting API Key can have any role. This command is invoking the endpoint with OperationID: 'createUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt index 597db52331..1abbdae740 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 -Returns information about the specified MongoDB Cloud user within the context of the specified organization. +experimental: Returns information about the specified MongoDB Cloud user within the context of the specified organization. To use this resource, the requesting API Key must have the Organization Read Only role. Note: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the Return One Organization API Key endpoint. Note: This resource does not return information about pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'getOrganizationUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getOrganizationUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt index 72dd3fe3dd..317396e708 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 -Returns information about the specified MongoDB Cloud user within the context of the specified project. +experimental: Returns information about the specified MongoDB Cloud user within the context of the specified project. To use this resource, the requesting API Key must have the Group Read Only role. Note: You can only use this resource to fetch information about MongoDB Cloud human users. To return information about an API Key, use the Return One Organization API Key endpoint. Note: This resource does not return information about pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'getProjectUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getProjectUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt index b7802867f7..c429feefcf 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 -Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. +experimental: 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 API Key can have any role. This command is invoking the endpoint with OperationID: 'getUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt index 853aea0086..30ea854e9d 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 -Returns the details for one MongoDB Cloud user account with the specified username. +experimental: 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 API Key can have any role. This command is invoking the endpoint with OperationID: 'getUserByUsername'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUserByUsername diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt index d8eea9a55c..0e03a0c65a 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 -Removes one organization-level role from the MongoDB Cloud user. +experimental: Removes one organization-level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting API Key must have the Organization Owner role. Note: This operation is atomic. Note: This resource cannot be used to remove a role from users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'removeOrganizationRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationRole diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt index bed7265735..0bcef0b4bd 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 -Removes one project-level role from the MongoDB Cloud user. +experimental: 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 API Key must have the Project Owner role. Note: This resource cannot be used to remove a role from users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'removeProjectRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectRole diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt index 3117db1d0f..ffd2a0f839 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 -Removes one MongoDB Cloud user from one team. +experimental: 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 API Key must have the Organization Owner role. Note: This resource cannot be used to remove a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'removeUserFromTeam'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeUserFromTeam diff --git a/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt index 453cc7ff32..183e7a31e4 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 -Updates one MongoDB Cloud user in the specified organization. +experimental: Updates one MongoDB Cloud user in the specified organization. You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role. Note: Only include the fields you wish to update in the request body. Supplying a field with an empty value will reset that field on the user. Note: This resource cannot be used to update pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'updateOrganizationUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrganizationUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers.txt index e94b6b20cf..dc4d1cd0c8 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 -Returns, adds, and edits MongoDB Cloud users. +experimental: Returns, adds, and edits MongoDB Cloud users. Options ------- @@ -49,20 +49,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-mongoDbCloudUsers-addOrganizationRole` - Adds one organization-level role to the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-addProjectRole` - Adds one project-level role to the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-addProjectUser` - Adds one MongoDB Cloud user to one project. -* :ref:`atlas-api-mongoDbCloudUsers-addUserToTeam` - Adds one MongoDB Cloud user to one team. -* :ref:`atlas-api-mongoDbCloudUsers-createOrganizationUser` - Invites one new or existing MongoDB Cloud user to join the organization. -* :ref:`atlas-api-mongoDbCloudUsers-createUser` - Creates one MongoDB Cloud user account. -* :ref:`atlas-api-mongoDbCloudUsers-getOrganizationUser` - Returns information about the specified MongoDB Cloud user within the context of the specified organization. -* :ref:`atlas-api-mongoDbCloudUsers-getProjectUser` - Returns information about the specified MongoDB Cloud user within the context of the specified project. -* :ref:`atlas-api-mongoDbCloudUsers-getUser` - Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. -* :ref:`atlas-api-mongoDbCloudUsers-getUserByUsername` - Returns the details for one MongoDB Cloud user account with the specified username. -* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationRole` - Removes one organization-level role from the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-removeProjectRole` - Removes one project-level role from the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-removeUserFromTeam` - Removes one MongoDB Cloud user from one team. -* :ref:`atlas-api-mongoDbCloudUsers-updateOrganizationUser` - Updates one MongoDB Cloud user in the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-addOrganizationRole` - experimental: Adds one organization-level role to the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-addProjectRole` - experimental: Adds one project-level role to the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-addProjectUser` - experimental: Adds one MongoDB Cloud user to one project. +* :ref:`atlas-api-mongoDbCloudUsers-addUserToTeam` - experimental: Adds one MongoDB Cloud user to one team. +* :ref:`atlas-api-mongoDbCloudUsers-createOrganizationUser` - experimental: Invites one new or existing MongoDB Cloud user to join the organization. +* :ref:`atlas-api-mongoDbCloudUsers-createUser` - experimental: Creates one MongoDB Cloud user account. +* :ref:`atlas-api-mongoDbCloudUsers-getOrganizationUser` - experimental: Returns information about the specified MongoDB Cloud user within the context of the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-getProjectUser` - experimental: Returns information about the specified MongoDB Cloud user within the context of the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-getUser` - experimental: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. +* :ref:`atlas-api-mongoDbCloudUsers-getUserByUsername` - experimental: Returns the details for one MongoDB Cloud user account with the specified username. +* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationRole` - experimental: Removes one organization-level role from the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-removeProjectRole` - experimental: Removes one project-level role from the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-removeUserFromTeam` - experimental: Removes one MongoDB Cloud user from one team. +* :ref:`atlas-api-mongoDbCloudUsers-updateOrganizationUser` - experimental: 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 06542f19b5..041c9975ab 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 -Returns the processes for the specified host for the specified project. +experimental: Returns the processes for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getAtlasProcess'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getAtlasProcess diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt index ec91d230bc..add7c0aba6 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 -Returns one database running on the specified host for the specified project. +experimental: Returns one database running on the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getDatabase'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabase diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt index 59b4bea002..2a42225f27 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 -Returns the measurements of one database for the specified host for the specified project. +experimental: Returns the measurements of one database for the specified host for the specified project. Returns the database's on-disk storage space based on the MongoDB dbStats command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getDatabaseMeasurements'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabaseMeasurements diff --git a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt index 1ec6b94b20..1b8652e50f 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 -Returns the measurements of one disk or partition for the specified host for the specified project. +experimental: 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 e53cbe1647..a15cb3dd36 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 -Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. +experimental: 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 API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". This command is invoking the endpoint with OperationID: 'getHostLogs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostLogs diff --git a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt index 23ac2f18bb..db65f848bb 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 -Returns disk, partition, or host measurements per process for the specified host for the specified project. +experimental: 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 8b591ac409..e9b36e4ae9 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 -Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. +experimental: 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. This command is invoking the endpoint with OperationID: 'getIndexMetrics'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getIndexMetrics diff --git a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt index ffe4f5b7c9..6f16a92cb2 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 -Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. +experimental: 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. This command is invoking the endpoint with OperationID: 'getMeasurements'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getMeasurements diff --git a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt b/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt index ac52fdde45..817715ff41 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 -Returns details of all processes for the specified project. +experimental: Returns details of all processes for the specified project. A MongoDB process can be either a mongod or mongos. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listAtlasProcesses'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listAtlasProcesses diff --git a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt index b4862e6ba8..50b4df0193 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 -Returns the list of databases running on the specified host for the specified project. +experimental: Returns the list of databases running on the specified host for the specified project. M0 free clusters, M2, M5, and serverless clusters have some operational limits. The MongoDB Cloud process must be a mongod. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listDatabases'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDatabases diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt index bd8ab62b9c..19f90d08b1 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 -Returns measurement details for one disk or partition for the specified host for the specified project. +experimental: Returns measurement details for one disk or partition for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listDiskMeasurements'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskMeasurements diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt index d5b25436f0..538547916e 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 -Returns the list of disks or partitions for the specified host for the specified project. +experimental: Returns the list of disks or partitions for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listDiskPartitions'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskPartitions diff --git a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt b/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt index 0611c4b06f..f879d5b360 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 -Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. +experimental: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. This command is invoking the endpoint with OperationID: 'listIndexMetrics'. For more information about flags, format of --file and examples, see: 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 608650f93e..1147ca926b 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 -Returns all Atlas Search metric types available for one process in the specified project. +experimental: 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. This command is invoking the endpoint with OperationID: 'listMetricTypes'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listMetricTypes diff --git a/docs/command/atlas-api-monitoringAndLogs.txt b/docs/command/atlas-api-monitoringAndLogs.txt index 28b7245c4c..1c478f2a71 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 -Returns database deployment monitoring and logging data. +experimental: Returns database deployment monitoring and logging data. Options ------- @@ -49,20 +49,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-monitoringAndLogs-getAtlasProcess` - Returns the processes for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDatabase` - Returns one database running on the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDatabaseMeasurements` - Returns the measurements of one database for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDiskMeasurements` - Returns the measurements of one disk or partition for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getHostLogs` - Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getHostMeasurements` - Returns disk, partition, or host measurements per process for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getIndexMetrics` - Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. -* :ref:`atlas-api-monitoringAndLogs-getMeasurements` - Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. -* :ref:`atlas-api-monitoringAndLogs-listAtlasProcesses` - Returns details of all processes for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDatabases` - Returns the list of databases running on the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDiskMeasurements` - Returns measurement details for one disk or partition for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDiskPartitions` - Returns the list of disks or partitions for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listIndexMetrics` - Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. -* :ref:`atlas-api-monitoringAndLogs-listMetricTypes` - Returns all Atlas Search metric types available for one process in the specified project. +* :ref:`atlas-api-monitoringAndLogs-getAtlasProcess` - experimental: Returns the processes for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDatabase` - experimental: Returns one database running on the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDatabaseMeasurements` - experimental: Returns the measurements of one database for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDiskMeasurements` - experimental: Returns the measurements of one disk or partition for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getHostLogs` - experimental: 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` - experimental: Returns disk, partition, or host measurements per process for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getIndexMetrics` - experimental: 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` - experimental: 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` - experimental: Returns details of all processes for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDatabases` - experimental: Returns the list of databases running on the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDiskMeasurements` - experimental: Returns measurement details for one disk or partition for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDiskPartitions` - experimental: Returns the list of disks or partitions for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listIndexMetrics` - experimental: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. +* :ref:`atlas-api-monitoringAndLogs-listMetricTypes` - experimental: 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 a3fe71ff8e..757db766f0 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 -Creates one new network peering connection in the specified project. +experimental: Creates one new network peering connection in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. This command is invoking the endpoint with OperationID: 'createPeeringConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringConnection diff --git a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt b/docs/command/atlas-api-networkPeering-createPeeringContainer.txt index abacf9e984..3f098e2863 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 -Creates one new network peering container in the specified project. +experimental: Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createPeeringContainer'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringContainer diff --git a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt b/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt index 6b1130b7bc..ea33252d23 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 -Removes one network peering connection in the specified project. +experimental: Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deletePeeringConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringConnection diff --git a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt b/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt index a7f74f8c02..ac34817b53 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 -Removes one network peering container in the specified project. +experimental: Removes one network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deletePeeringContainer'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringContainer diff --git a/docs/command/atlas-api-networkPeering-disablePeering.txt b/docs/command/atlas-api-networkPeering-disablePeering.txt index 5e84acb425..14ec7b5a86 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 -Disables Connect via Peering Only mode for the specified project. +experimental: Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'disablePeering'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/disablePeering diff --git a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt b/docs/command/atlas-api-networkPeering-getPeeringConnection.txt index 5526cb93f3..1d4d67bdf7 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 -Returns details about one specified network peering connection in the specified project. +experimental: Returns details about one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPeeringConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringConnection diff --git a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt b/docs/command/atlas-api-networkPeering-getPeeringContainer.txt index 23dca14afd..f9f7934e92 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 -Returns details about one network peering container in one specified project. +experimental: Returns details about one network peering container in one specified project. Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPeeringContainer'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringContainer diff --git a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt b/docs/command/atlas-api-networkPeering-listPeeringConnections.txt index 6d57029579..9bdcb4dcb4 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 -Returns details about all network peering connections in the specified project. +experimental: Returns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPeeringConnections'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringConnections diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt b/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt index 05e1dbc15b..2217a1bb78 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 -Returns details about all network peering containers in the specified project for the specified cloud provider. +experimental: Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPeeringContainerByCloudProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainerByCloudProvider diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt b/docs/command/atlas-api-networkPeering-listPeeringContainers.txt index eeb1d3b278..45da85e3a9 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 -Returns details about all network peering containers in the specified project. +experimental: Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPeeringContainers'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainers diff --git a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt b/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt index c95f60a20a..709fc8d303 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 -Updates one specified network peering connection in the specified project. +experimental: Updates one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updatePeeringConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringConnection diff --git a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt b/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt index 902644136e..6dde0dfdac 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 -Updates the network details and labels of one specified network peering container in the specified project. +experimental: Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updatePeeringContainer'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringContainer diff --git a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt b/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt index eed0923626..f57be00249 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 -Verifies if someone set the specified project to Connect via Peering Only mode. +experimental: Verifies if someone set the specified project to Connect via Peering Only mode. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'verifyConnectViaPeeringOnlyModeForOneProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/verifyConnectViaPeeringOnlyModeForOneProject diff --git a/docs/command/atlas-api-networkPeering.txt b/docs/command/atlas-api-networkPeering.txt index 491982631f..7863afa279 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 -Returns, adds, edits, and removes network peering containers and peering connections. +experimental: 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 +51,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-networkPeering-createPeeringConnection` - Creates one new network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-createPeeringContainer` - Creates one new network peering container in the specified project. -* :ref:`atlas-api-networkPeering-deletePeeringConnection` - Removes one network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-deletePeeringContainer` - Removes one network peering container in the specified project. -* :ref:`atlas-api-networkPeering-disablePeering` - Disables Connect via Peering Only mode for the specified project. -* :ref:`atlas-api-networkPeering-getPeeringConnection` - Returns details about one specified network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-getPeeringContainer` - Returns details about one network peering container in one specified project. -* :ref:`atlas-api-networkPeering-listPeeringConnections` - Returns details about all network peering connections in the specified project. -* :ref:`atlas-api-networkPeering-listPeeringContainerByCloudProvider` - Returns details about all network peering containers in the specified project for the specified cloud provider. -* :ref:`atlas-api-networkPeering-listPeeringContainers` - Returns details about all network peering containers in the specified project. -* :ref:`atlas-api-networkPeering-updatePeeringConnection` - Updates one specified network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-updatePeeringContainer` - Updates the network details and labels of one specified network peering container in the specified project. -* :ref:`atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject` - Verifies if someone set the specified project to Connect via Peering Only mode. +* :ref:`atlas-api-networkPeering-createPeeringConnection` - experimental: Creates one new network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-createPeeringContainer` - experimental: Creates one new network peering container in the specified project. +* :ref:`atlas-api-networkPeering-deletePeeringConnection` - experimental: Removes one network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-deletePeeringContainer` - experimental: Removes one network peering container in the specified project. +* :ref:`atlas-api-networkPeering-disablePeering` - experimental: Disables Connect via Peering Only mode for the specified project. +* :ref:`atlas-api-networkPeering-getPeeringConnection` - experimental: Returns details about one specified network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-getPeeringContainer` - experimental: Returns details about one network peering container in one specified project. +* :ref:`atlas-api-networkPeering-listPeeringConnections` - experimental: Returns details about all network peering connections in the specified project. +* :ref:`atlas-api-networkPeering-listPeeringContainerByCloudProvider` - experimental: Returns details about all network peering containers in the specified project for the specified cloud provider. +* :ref:`atlas-api-networkPeering-listPeeringContainers` - experimental: Returns details about all network peering containers in the specified project. +* :ref:`atlas-api-networkPeering-updatePeeringConnection` - experimental: Updates one specified network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-updatePeeringContainer` - experimental: Updates the network details and labels of one specified network peering container in the specified project. +* :ref:`atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject` - experimental: 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 278c68d758..d6974ec15d 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 -Creates one online archive. +experimental: Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'createOnlineArchive'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/createOnlineArchive diff --git a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt index c353667200..0d3e801705 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 -Removes one online archive. +experimental: Removes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'deleteOnlineArchive'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/deleteOnlineArchive diff --git a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt b/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt index 0c7b94a64d..52fcc1a2df 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 -Downloads query logs for the specified online archive. +experimental: Downloads query logs for the specified online archive. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". This command is invoking the endpoint with OperationID: 'downloadOnlineArchiveQueryLogs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadOnlineArchiveQueryLogs diff --git a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt index d779eb0dec..4c2bacf3f5 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 -Returns one online archive for one cluster. +experimental: Returns one online archive for one cluster. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getOnlineArchive'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/getOnlineArchive diff --git a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt index 461e44e7cd..4ea545f93a 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 -Returns details of all online archives. +experimental: Returns details of all online archives. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listOnlineArchives'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/listOnlineArchives diff --git a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt index 991f8009fb..45b489dea9 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 -Updates, pauses, or resumes one online archive. +experimental: Updates, pauses, or resumes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'updateOnlineArchive'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/updateOnlineArchive diff --git a/docs/command/atlas-api-onlineArchive.txt b/docs/command/atlas-api-onlineArchive.txt index d76e4693ab..aeb8f6c9d4 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 -Returns, adds, edits, or removes an online archive. +experimental: Returns, adds, edits, or removes an online archive. Options ------- @@ -49,12 +49,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-onlineArchive-createOnlineArchive` - Creates one online archive. -* :ref:`atlas-api-onlineArchive-deleteOnlineArchive` - Removes one online archive. -* :ref:`atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs` - Downloads query logs for the specified online archive. -* :ref:`atlas-api-onlineArchive-getOnlineArchive` - Returns one online archive for one cluster. -* :ref:`atlas-api-onlineArchive-listOnlineArchives` - Returns details of all online archives. -* :ref:`atlas-api-onlineArchive-updateOnlineArchive` - Updates, pauses, or resumes one online archive. +* :ref:`atlas-api-onlineArchive-createOnlineArchive` - experimental: Creates one online archive. +* :ref:`atlas-api-onlineArchive-deleteOnlineArchive` - experimental: Removes one online archive. +* :ref:`atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs` - experimental: Downloads query logs for the specified online archive. +* :ref:`atlas-api-onlineArchive-getOnlineArchive` - experimental: Returns one online archive for one cluster. +* :ref:`atlas-api-onlineArchive-listOnlineArchives` - experimental: Returns details of all online archives. +* :ref:`atlas-api-onlineArchive-updateOnlineArchive` - experimental: Updates, pauses, or resumes one online archive. .. toctree:: diff --git a/docs/command/atlas-api-openApi-getApiVersions.txt b/docs/command/atlas-api-openApi-getApiVersions.txt index 54f9ec7ced..88614cee07 100644 --- a/docs/command/atlas-api-openApi-getApiVersions.txt +++ b/docs/command/atlas-api-openApi-getApiVersions.txt @@ -12,7 +12,7 @@ atlas api openApi getApiVersions :depth: 1 :class: singlecol -API that provides a list of available versionsfor a given environment. +experimental: API that provides a list of available versionsfor a given environment. This command is invoking the endpoint with OperationID: 'getApiVersions'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/OpenAPI/operation/getApiVersions diff --git a/docs/command/atlas-api-openApi-getOpenApiInfo.txt b/docs/command/atlas-api-openApi-getOpenApiInfo.txt index be429815dd..a7ebb4810d 100644 --- a/docs/command/atlas-api-openApi-getOpenApiInfo.txt +++ b/docs/command/atlas-api-openApi-getOpenApiInfo.txt @@ -12,7 +12,7 @@ atlas api openApi getOpenApiInfo :depth: 1 :class: singlecol -This resource returns general information about the MongoDB Atlas Administration API OpenAPI Specification. +experimental: This resource returns general information about the MongoDB Atlas Administration API OpenAPI Specification. This command is invoking the endpoint with OperationID: 'getOpenApiInfo'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/OpenAPI/operation/getOpenApiInfo diff --git a/docs/command/atlas-api-openApi.txt b/docs/command/atlas-api-openApi.txt index abef038683..8cf5487abd 100644 --- a/docs/command/atlas-api-openApi.txt +++ b/docs/command/atlas-api-openApi.txt @@ -12,7 +12,7 @@ atlas api openApi :depth: 1 :class: singlecol -Returns information about the MongoDB Atlas Specification. +experimental: Returns information about the MongoDB Atlas Specification. Options ------- @@ -49,8 +49,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-openApi-getApiVersions` - API that provides a list of available versionsfor a given environment. -* :ref:`atlas-api-openApi-getOpenApiInfo` - This resource returns general information about the MongoDB Atlas Administration API OpenAPI Specification. +* :ref:`atlas-api-openApi-getApiVersions` - experimental: API that provides a list of available versionsfor a given environment. +* :ref:`atlas-api-openApi-getOpenApiInfo` - experimental: This resource returns general information about the MongoDB Atlas Administration API OpenAPI Specification. .. toctree:: diff --git a/docs/command/atlas-api-organizations-createOrganization.txt b/docs/command/atlas-api-organizations-createOrganization.txt index 8449668e4a..5e93c0f606 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 -Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. +experimental: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. To use this resource, the requesting API Key must have the Organization Owner role. The requesting API Key's organization must be a paying organization. To learn more, see Configure a Paying Organization in the MongoDB Atlas documentation. This command is invoking the endpoint with OperationID: 'createOrganization'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganization diff --git a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt b/docs/command/atlas-api-organizations-createOrganizationInvitation.txt index d33ea0b971..3df89c2ae9 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 -Invites one MongoDB Cloud user to join the specified organization. +experimental: Invites one MongoDB Cloud user to join the specified organization. The user must accept the invitation to access information within the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'createOrganizationInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganizationInvitation diff --git a/docs/command/atlas-api-organizations-deleteOrganization.txt b/docs/command/atlas-api-organizations-deleteOrganization.txt index 31f2ba8efb..c302a568c6 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 -Removes one specified organization. +experimental: 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 4d50cb652b..a1b1bb4b47 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 -Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. +experimental: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'deleteOrganizationInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganizationInvitation diff --git a/docs/command/atlas-api-organizations-getOrganization.txt b/docs/command/atlas-api-organizations-getOrganization.txt index 8512c624a9..45c4a7607b 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 -Returns one organization to which the requesting API key has access. +experimental: Returns one organization to which the requesting API key has access. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'getOrganization'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganization diff --git a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt b/docs/command/atlas-api-organizations-getOrganizationInvitation.txt index b31aeb6339..0df71cb59c 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 -Returns the details of one pending invitation to the specified organization. +experimental: Returns the details of one pending invitation to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'getOrganizationInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationInvitation diff --git a/docs/command/atlas-api-organizations-getOrganizationSettings.txt b/docs/command/atlas-api-organizations-getOrganizationSettings.txt index 51d9c941ad..326ab821e7 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 -Returns details about the specified organization's settings. +experimental: Returns details about the specified organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'getOrganizationSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationSettings diff --git a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt index c5dbad5445..3c3664ddea 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 -Returns all pending invitations to the specified organization. +experimental: Returns all pending invitations to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'listOrganizationInvitations'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationInvitations diff --git a/docs/command/atlas-api-organizations-listOrganizationProjects.txt b/docs/command/atlas-api-organizations-listOrganizationProjects.txt index e2bed9136d..4065d1bd22 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 -Returns multiple projects in the specified organization. +experimental: Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to: diff --git a/docs/command/atlas-api-organizations-listOrganizationUsers.txt b/docs/command/atlas-api-organizations-listOrganizationUsers.txt index 1a3233ba5c..4f36286eb7 100644 --- a/docs/command/atlas-api-organizations-listOrganizationUsers.txt +++ b/docs/command/atlas-api-organizations-listOrganizationUsers.txt @@ -12,7 +12,7 @@ atlas api organizations listOrganizationUsers :depth: 1 :class: singlecol -Returns details about the MongoDB Cloud users associated with the specified organization. +experimental: Returns details about the MongoDB Cloud users associated with the specified organization. Each MongoDB Cloud user returned must belong to the specified organization or to a project within the specified organization. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listOrganizationUsers'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationUsers diff --git a/docs/command/atlas-api-organizations-listOrganizations.txt b/docs/command/atlas-api-organizations-listOrganizations.txt index 408c0608c5..e27db6f8b3 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 -Returns all organizations to which the requesting API Key has access. +experimental: Returns all organizations to which the requesting API Key has access. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listOrganizations'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizations diff --git a/docs/command/atlas-api-organizations-removeOrganizationUser.txt b/docs/command/atlas-api-organizations-removeOrganizationUser.txt index 71f9578346..b92c2bfdce 100644 --- a/docs/command/atlas-api-organizations-removeOrganizationUser.txt +++ b/docs/command/atlas-api-organizations-removeOrganizationUser.txt @@ -12,7 +12,7 @@ atlas api organizations removeOrganizationUser :depth: 1 :class: singlecol -Removes one MongoDB Cloud user from the specified organization. +experimental: Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. This command is invoking the endpoint with OperationID: 'removeOrganizationUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/removeOrganizationUser diff --git a/docs/command/atlas-api-organizations-updateOrganization.txt b/docs/command/atlas-api-organizations-updateOrganization.txt index c837fe2679..f91b72e580 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 -Updates one organization. +experimental: Updates one organization. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'updateOrganization'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganization diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt index 6d86bee200..06cf1dd11d 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 -Updates the details of one pending invitation to the specified organization. +experimental: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the username of the invited user. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'updateOrganizationInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitation diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt index 07c14b0100..2408fc81fb 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 -Updates the details of one pending invitation to the specified organization. +experimental: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the unique identification string for that invitation. Use the Return All Organization Invitations endpoint to retrieve IDs for all pending organization invitations. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'updateOrganizationInvitationById'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitationById diff --git a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt b/docs/command/atlas-api-organizations-updateOrganizationRoles.txt index 4b7c5bf06f..9cfa0071a0 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 -Updates the roles of the specified user in the specified organization. +experimental: Updates the roles of the specified user in the specified organization. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. This command is invoking the endpoint with OperationID: 'updateOrganizationRoles'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationRoles diff --git a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt b/docs/command/atlas-api-organizations-updateOrganizationSettings.txt index 9eb32054ba..795a8a4e34 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 -Updates the organization's settings. +experimental: Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'updateOrganizationSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationSettings diff --git a/docs/command/atlas-api-organizations.txt b/docs/command/atlas-api-organizations.txt index 997030afff..2135b5a4e3 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 -Returns, adds, and edits organizational units in MongoDB Cloud. +experimental: Returns, adds, and edits organizational units in MongoDB Cloud. Options ------- @@ -49,23 +49,23 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-organizations-createOrganization` - Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. -* :ref:`atlas-api-organizations-createOrganizationInvitation` - Invites one MongoDB Cloud user to join the specified organization. -* :ref:`atlas-api-organizations-deleteOrganization` - Removes one specified organization. -* :ref:`atlas-api-organizations-deleteOrganizationInvitation` - Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. -* :ref:`atlas-api-organizations-getOrganization` - Returns one organization to which the requesting API key has access. -* :ref:`atlas-api-organizations-getOrganizationInvitation` - Returns the details of one pending invitation to the specified organization. -* :ref:`atlas-api-organizations-getOrganizationSettings` - Returns details about the specified organization's settings. -* :ref:`atlas-api-organizations-listOrganizationInvitations` - Returns all pending invitations to the specified organization. -* :ref:`atlas-api-organizations-listOrganizationProjects` - Returns multiple projects in the specified organization. -* :ref:`atlas-api-organizations-listOrganizationUsers` - Returns details about the MongoDB Cloud users associated with the specified organization. -* :ref:`atlas-api-organizations-listOrganizations` - Returns all organizations to which the requesting API Key has access. -* :ref:`atlas-api-organizations-removeOrganizationUser` - Removes one MongoDB Cloud user from the specified organization. -* :ref:`atlas-api-organizations-updateOrganization` - Updates one organization. -* :ref:`atlas-api-organizations-updateOrganizationInvitation` - Updates the details of one pending invitation to the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationInvitationById` - Updates the details of one pending invitation to the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationRoles` - Updates the roles of the specified user in the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationSettings` - Updates the organization's settings. +* :ref:`atlas-api-organizations-createOrganization` - experimental: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. +* :ref:`atlas-api-organizations-createOrganizationInvitation` - experimental: Invites one MongoDB Cloud user to join the specified organization. +* :ref:`atlas-api-organizations-deleteOrganization` - experimental: Removes one specified organization. +* :ref:`atlas-api-organizations-deleteOrganizationInvitation` - experimental: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. +* :ref:`atlas-api-organizations-getOrganization` - experimental: Returns one organization to which the requesting API key has access. +* :ref:`atlas-api-organizations-getOrganizationInvitation` - experimental: Returns the details of one pending invitation to the specified organization. +* :ref:`atlas-api-organizations-getOrganizationSettings` - experimental: Returns details about the specified organization's settings. +* :ref:`atlas-api-organizations-listOrganizationInvitations` - experimental: Returns all pending invitations to the specified organization. +* :ref:`atlas-api-organizations-listOrganizationProjects` - experimental: Returns multiple projects in the specified organization. +* :ref:`atlas-api-organizations-listOrganizationUsers` - experimental: Returns details about the MongoDB Cloud users associated with the specified organization. +* :ref:`atlas-api-organizations-listOrganizations` - experimental: Returns all organizations to which the requesting API Key has access. +* :ref:`atlas-api-organizations-removeOrganizationUser` - experimental: Removes one MongoDB Cloud user from the specified organization. +* :ref:`atlas-api-organizations-updateOrganization` - experimental: Updates one organization. +* :ref:`atlas-api-organizations-updateOrganizationInvitation` - experimental: Updates the details of one pending invitation to the specified organization. +* :ref:`atlas-api-organizations-updateOrganizationInvitationById` - experimental: Updates the details of one pending invitation to the specified organization. +* :ref:`atlas-api-organizations-updateOrganizationRoles` - experimental: Updates the roles of the specified user in the specified organization. +* :ref:`atlas-api-organizations-updateOrganizationSettings` - experimental: 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 7fe8487917..406307dcd8 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 -Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. +experimental: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'disableSlowOperationThresholding'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/disableSlowOperationThresholding diff --git a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt b/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt index 8c6a765466..e1a364b851 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 -Enables MongoDB Cloud to use its slow operation threshold for the specified project. +experimental: Enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'enableSlowOperationThresholding'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/enableSlowOperationThresholding diff --git a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt index e211776f66..88822b1037 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 -Get whether the Managed Slow MS feature is enabled. +experimental: Get whether the Managed Slow MS feature is enabled. This command is invoking the endpoint with OperationID: 'getManagedSlowMs'. For more information about flags, format of --file and examples, see: 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 97add31076..9fe266c91e 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 -Get whether the Serverless Auto Indexing feature is enabled. +experimental: Get whether the Serverless Auto Indexing feature is enabled. This command is invoking the endpoint with OperationID: 'getServerlessAutoIndexing'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getServerlessAutoIndexing diff --git a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt index 85197001de..69e8c7d05d 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 -Returns the indexes that the Performance Advisor suggests. +experimental: Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listClusterSuggestedIndexes'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listClusterSuggestedIndexes diff --git a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt index 5206619e5a..7aa5c877e9 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 -Returns the indexes that the Performance Advisor suggests to drop. +experimental: 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 API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listDropIndexes'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listDropIndexes diff --git a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt index 1edcde30bd..44ce7f9486 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 -Returns the schema suggestions that the Performance Advisor detects. +experimental: 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 API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listSchemaAdvice'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSchemaAdvice diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt index 6c67b5dce6..059a8f4865 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 -Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. +experimental: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'listSlowQueries'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueries diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt index c1061f202e..dde75f1661 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 -Returns up to 20 namespaces for collections experiencing slow queries on the specified host. +experimental: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listSlowQueryNamespaces'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueryNamespaces diff --git a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt index cfb885f5b3..7fafc12944 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 -Returns the indexes that the Performance Advisor suggests. +experimental: Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listSuggestedIndexes'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSuggestedIndexes diff --git a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt index 72adb4bff8..7ed42fd467 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 -Set whether the Serverless Auto Indexing feature is enabled. +experimental: Set whether the Serverless Auto Indexing feature is enabled. This command is invoking the endpoint with OperationID: 'setServerlessAutoIndexing'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/setServerlessAutoIndexing diff --git a/docs/command/atlas-api-performanceAdvisor.txt b/docs/command/atlas-api-performanceAdvisor.txt index 315c90abbd..ecc2cf9216 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 -Returns suggested indexes and slow query data for a database deployment. +experimental: 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 +51,17 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-performanceAdvisor-disableSlowOperationThresholding` - Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. -* :ref:`atlas-api-performanceAdvisor-enableSlowOperationThresholding` - Enables MongoDB Cloud to use its slow operation threshold for the specified project. -* :ref:`atlas-api-performanceAdvisor-getManagedSlowMs` - Get whether the Managed Slow MS feature is enabled. -* :ref:`atlas-api-performanceAdvisor-getServerlessAutoIndexing` - Get whether the Serverless Auto Indexing feature is enabled. -* :ref:`atlas-api-performanceAdvisor-listClusterSuggestedIndexes` - Returns the indexes that the Performance Advisor suggests. -* :ref:`atlas-api-performanceAdvisor-listDropIndexes` - Returns the indexes that the Performance Advisor suggests to drop. -* :ref:`atlas-api-performanceAdvisor-listSchemaAdvice` - Returns the schema suggestions that the Performance Advisor detects. -* :ref:`atlas-api-performanceAdvisor-listSlowQueries` - Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. -* :ref:`atlas-api-performanceAdvisor-listSlowQueryNamespaces` - Returns up to 20 namespaces for collections experiencing slow queries on the specified host. -* :ref:`atlas-api-performanceAdvisor-listSuggestedIndexes` - Returns the indexes that the Performance Advisor suggests. -* :ref:`atlas-api-performanceAdvisor-setServerlessAutoIndexing` - Set whether the Serverless Auto Indexing feature is enabled. +* :ref:`atlas-api-performanceAdvisor-disableSlowOperationThresholding` - experimental: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. +* :ref:`atlas-api-performanceAdvisor-enableSlowOperationThresholding` - experimental: Enables MongoDB Cloud to use its slow operation threshold for the specified project. +* :ref:`atlas-api-performanceAdvisor-getManagedSlowMs` - experimental: Get whether the Managed Slow MS feature is enabled. +* :ref:`atlas-api-performanceAdvisor-getServerlessAutoIndexing` - experimental: Get whether the Serverless Auto Indexing feature is enabled. +* :ref:`atlas-api-performanceAdvisor-listClusterSuggestedIndexes` - experimental: Returns the indexes that the Performance Advisor suggests. +* :ref:`atlas-api-performanceAdvisor-listDropIndexes` - experimental: Returns the indexes that the Performance Advisor suggests to drop. +* :ref:`atlas-api-performanceAdvisor-listSchemaAdvice` - experimental: Returns the schema suggestions that the Performance Advisor detects. +* :ref:`atlas-api-performanceAdvisor-listSlowQueries` - experimental: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. +* :ref:`atlas-api-performanceAdvisor-listSlowQueryNamespaces` - experimental: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. +* :ref:`atlas-api-performanceAdvisor-listSuggestedIndexes` - experimental: Returns the indexes that the Performance Advisor suggests. +* :ref:`atlas-api-performanceAdvisor-setServerlessAutoIndexing` - experimental: 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 3ff66dce05..32b735bb34 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 -Creates one private endpoint for the specified cloud service provider. +experimental: Creates one private endpoint for the specified cloud service provider. This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. This command is invoking the endpoint with OperationID: 'createPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpoint diff --git a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt index f117aa3149..4d659d57fe 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 -Creates one private endpoint service for the specified cloud service provider. +experimental: Creates one private endpoint service for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createPrivateEndpointService'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpointService diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt index 8f1db7b095..b4de5c21a1 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 -Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. +experimental: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deletePrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpoint diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt index ce0df49785..91ebcc1cdc 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 -Removes one private endpoint service from the specified project. +experimental: Removes one private endpoint service from the specified project. This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deletePrivateEndpointService'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpointService diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt index e915815ec4..16eae5f9ed 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 -Returns the connection state of the specified private endpoint. +experimental: Returns the connection state of the specified private endpoint. The private endpoint service manages this private endpoint which belongs to one project hosted from one cloud service provider. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpoint diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt index 1523f66ed8..9d7fa21e65 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 -Returns the name, interfaces, and state of the specified private endpoint service from one project. +experimental: Returns the name, interfaces, and state of the specified private endpoint service from one project. The cloud service provider hosted this private endpoint service that belongs to the project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPrivateEndpointService'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpointService diff --git a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt index 5e17fa7d80..cd03e79b60 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 -Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. +experimental: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. The cloud service provider manages the private endpoint for the project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getRegionalizedPrivateEndpointSetting'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getRegionalizedPrivateEndpointSetting diff --git a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt index d24b5b4200..14d70d502a 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 -Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. +experimental: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPrivateEndpointServices'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/listPrivateEndpointServices diff --git a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt index 160d5e6d2c..c7426eb27c 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 -Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. +experimental: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. The cloud service provider manages the private endpoints for the project. Connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime. To use this resource, the requesting API Key must have the Project Owner role and all clusters in the deployment must be sharded clusters. Once enabled, you cannot create replica sets. This command is invoking the endpoint with OperationID: 'toggleRegionalizedPrivateEndpointSetting'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/toggleRegionalizedPrivateEndpointSetting diff --git a/docs/command/atlas-api-privateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices.txt index c294bc065c..62edac847f 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 -Returns, adds, edits, and removes private endpoint services. +experimental: Returns, adds, edits, and removes private endpoint services. Options ------- @@ -49,15 +49,15 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-privateEndpointServices-createPrivateEndpoint` - Creates one private endpoint for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-createPrivateEndpointService` - Creates one private endpoint service for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpoint` - Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpointService` - Removes one private endpoint service from the specified project. -* :ref:`atlas-api-privateEndpointServices-getPrivateEndpoint` - Returns the connection state of the specified private endpoint. -* :ref:`atlas-api-privateEndpointServices-getPrivateEndpointService` - Returns the name, interfaces, and state of the specified private endpoint service from one project. -* :ref:`atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting` - Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. -* :ref:`atlas-api-privateEndpointServices-listPrivateEndpointServices` - Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting` - Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. +* :ref:`atlas-api-privateEndpointServices-createPrivateEndpoint` - experimental: Creates one private endpoint for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-createPrivateEndpointService` - experimental: Creates one private endpoint service for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpoint` - experimental: 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` - experimental: Removes one private endpoint service from the specified project. +* :ref:`atlas-api-privateEndpointServices-getPrivateEndpoint` - experimental: Returns the connection state of the specified private endpoint. +* :ref:`atlas-api-privateEndpointServices-getPrivateEndpointService` - experimental: Returns the name, interfaces, and state of the specified private endpoint service from one project. +* :ref:`atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting` - experimental: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. +* :ref:`atlas-api-privateEndpointServices-listPrivateEndpointServices` - experimental: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting` - experimental: 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 bfa1ff9f73..35b66e0065 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 -Assigns the specified organization API key to the specified project. +experimental: Assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'addProjectApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addProjectApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt index dc08558313..5eb0d5b2e0 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 -Creates one API key for the specified organization. +experimental: Creates one API key for the specified organization. An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'createApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt index ca928fdac1..7ce415994d 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 -Creates the access list entries for the specified organization API key. +experimental: Creates the access list entries for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role. This command is invoking the endpoint with OperationID: 'createApiKeyAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKeyAccessList diff --git a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt index 5828e55aa4..d47228e994 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 -Creates and assigns the specified organization API key to the specified project. +experimental: Creates and assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createProjectApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt index 8d143f4ffc..2e006f0c62 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 -Removes one organization API key from the specified organization. +experimental: Removes one organization API key from the specified organization. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'deleteApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt index 39acbb278f..9ed426d1aa 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 -Removes the specified access list entry from the specified organization API key. +experimental: Removes the specified access list entry from the specified organization API key. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. This command is invoking the endpoint with OperationID: 'deleteApiKeyAccessListEntry'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKeyAccessListEntry diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt index 8b1d6b8e4e..cbf4fdc6f8 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 -Returns one organization API key. +experimental: Returns one organization API key. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'getApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt index 1c82e34783..fb20d992e9 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 -Returns one access list entry for the specified organization API key. +experimental: Returns one access list entry for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'getApiKeyAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKeyAccessList diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt index 5bfad16b4a..9fb4de209f 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 -Returns all access list entries that you configured for the specified organization API key. +experimental: Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listApiKeyAccessListsEntries'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeyAccessListsEntries diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt index a0c7041660..beb1c67976 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 -Returns all organization API keys for the specified organization. +experimental: Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listApiKeys'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeys diff --git a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt index e50ae8c99b..fb36e4dd37 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 -Returns all organization API keys that you assigned to the specified project. +experimental: Returns all organization API keys that you assigned to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'listProjectApiKeys'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listProjectApiKeys diff --git a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt index bc04ca18fc..e71fa8932f 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 -Removes one organization API key from the specified project. +experimental: Removes one organization API key from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'removeProjectApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/removeProjectApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt index 64b807760f..3bbe30acef 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 -Updates one organization API key in the specified organization. +experimental: 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. This command is invoking the endpoint with OperationID: 'updateApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt index d31a71e4bd..683c0eea87 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 -Updates the roles of the organization API key that you specify for the project that you specify. +experimental: 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. This command is invoking the endpoint with OperationID: 'updateApiKeyRoles'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKeyRoles diff --git a/docs/command/atlas-api-programmaticApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys.txt index 550632a4bd..553e440d9d 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 -Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. +experimental: 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 +51,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-programmaticApiKeys-addProjectApiKey` - Assigns the specified organization API key to the specified project. -* :ref:`atlas-api-programmaticApiKeys-createApiKey` - Creates one API key for the specified organization. -* :ref:`atlas-api-programmaticApiKeys-createApiKeyAccessList` - Creates the access list entries for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-createProjectApiKey` - Creates and assigns the specified organization API key to the specified project. -* :ref:`atlas-api-programmaticApiKeys-deleteApiKey` - Removes one organization API key from the specified organization. -* :ref:`atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry` - Removes the specified access list entry from the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-getApiKey` - Returns one organization API key. -* :ref:`atlas-api-programmaticApiKeys-getApiKeyAccessList` - Returns one access list entry for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries` - Returns all access list entries that you configured for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-listApiKeys` - Returns all organization API keys for the specified organization. -* :ref:`atlas-api-programmaticApiKeys-listProjectApiKeys` - Returns all organization API keys that you assigned to the specified project. -* :ref:`atlas-api-programmaticApiKeys-removeProjectApiKey` - Removes one organization API key from the specified project. -* :ref:`atlas-api-programmaticApiKeys-updateApiKey` - Updates one organization API key in the specified organization. -* :ref:`atlas-api-programmaticApiKeys-updateApiKeyRoles` - Updates the roles of the organization API key that you specify for the project that you specify. +* :ref:`atlas-api-programmaticApiKeys-addProjectApiKey` - experimental: Assigns the specified organization API key to the specified project. +* :ref:`atlas-api-programmaticApiKeys-createApiKey` - experimental: Creates one API key for the specified organization. +* :ref:`atlas-api-programmaticApiKeys-createApiKeyAccessList` - experimental: Creates the access list entries for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-createProjectApiKey` - experimental: Creates and assigns the specified organization API key to the specified project. +* :ref:`atlas-api-programmaticApiKeys-deleteApiKey` - experimental: Removes one organization API key from the specified organization. +* :ref:`atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry` - experimental: Removes the specified access list entry from the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-getApiKey` - experimental: Returns one organization API key. +* :ref:`atlas-api-programmaticApiKeys-getApiKeyAccessList` - experimental: Returns one access list entry for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries` - experimental: Returns all access list entries that you configured for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-listApiKeys` - experimental: Returns all organization API keys for the specified organization. +* :ref:`atlas-api-programmaticApiKeys-listProjectApiKeys` - experimental: Returns all organization API keys that you assigned to the specified project. +* :ref:`atlas-api-programmaticApiKeys-removeProjectApiKey` - experimental: Removes one organization API key from the specified project. +* :ref:`atlas-api-programmaticApiKeys-updateApiKey` - experimental: Updates one organization API key in the specified organization. +* :ref:`atlas-api-programmaticApiKeys-updateApiKeyRoles` - experimental: 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 346eb5c6b5..ac9c253674 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 -Adds one or more access list entries to the specified project. +experimental: Adds one or more access list entries to the specified project. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent POST requests. You must submit multiple POST requests synchronously. This command is invoking the endpoint with OperationID: 'createProjectIpAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/createProjectIpAccessList diff --git a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt index c7249afb81..c95f9bcf5a 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 -Removes one access list entry from the specified project's IP access list. +experimental: Removes one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This command is invoking the endpoint with OperationID: 'deleteProjectIpAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/deleteProjectIpAccessList diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt index 77658421cb..0817450535 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 -Returns the status of one project IP access list entry. +experimental: 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. This command is invoking the endpoint with OperationID: 'getProjectIpAccessListStatus'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpAccessListStatus diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt index 84f2f8e8ac..8391e30fd6 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 -Returns one access list entry from the specified project's IP access list. +experimental: Returns one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. This endpoint (/groups/{GROUP-ID}/accessList) manages the Project IP Access List. It doesn't manage the access list for MongoDB Cloud organizations. TheProgrammatic API Keys endpoint (/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist) manages those access lists. This command is invoking the endpoint with OperationID: 'getProjectIpList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpList diff --git a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt b/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt index d2467460e3..f1fa26d033 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 -Returns all access list entries from the specified project's IP access list. +experimental: Returns all access list entries from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This command is invoking the endpoint with OperationID: 'listProjectIpAccessLists'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/listProjectIpAccessLists diff --git a/docs/command/atlas-api-projectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList.txt index b82b4215a9..d604f1c26c 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 -Returns, adds, edits, and removes network access limits to database deployments in Atlas. +experimental: 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 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projectIpAccessList-createProjectIpAccessList` - Adds one or more access list entries to the specified project. -* :ref:`atlas-api-projectIpAccessList-deleteProjectIpAccessList` - Removes one access list entry from the specified project's IP access list. -* :ref:`atlas-api-projectIpAccessList-getProjectIpAccessListStatus` - Returns the status of one project IP access list entry. -* :ref:`atlas-api-projectIpAccessList-getProjectIpList` - Returns one access list entry from the specified project's IP access list. -* :ref:`atlas-api-projectIpAccessList-listProjectIpAccessLists` - Returns all access list entries from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-createProjectIpAccessList` - experimental: Adds one or more access list entries to the specified project. +* :ref:`atlas-api-projectIpAccessList-deleteProjectIpAccessList` - experimental: Removes one access list entry from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-getProjectIpAccessListStatus` - experimental: Returns the status of one project IP access list entry. +* :ref:`atlas-api-projectIpAccessList-getProjectIpList` - experimental: Returns one access list entry from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-listProjectIpAccessLists` - experimental: 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 6d3194c3e8..8e246d2e32 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 -Adds one MongoDB Cloud user to the specified project. +experimental: Adds one MongoDB Cloud user to the specified project. If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting API Key must have the Group User Admin role. This command is invoking the endpoint with OperationID: 'addUserToProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/addUserToProject diff --git a/docs/command/atlas-api-projects-createProject.txt b/docs/command/atlas-api-projects-createProject.txt index 8479d93ffb..53ab43586a 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 -Creates one project. +experimental: Creates one project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Read Write role. This command is invoking the endpoint with OperationID: 'createProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProject diff --git a/docs/command/atlas-api-projects-createProjectInvitation.txt b/docs/command/atlas-api-projects-createProjectInvitation.txt index d5ec95a9af..266d284979 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 -Invites one MongoDB Cloud user to join the specified project. +experimental: Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createProjectInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation diff --git a/docs/command/atlas-api-projects-deleteProject.txt b/docs/command/atlas-api-projects-deleteProject.txt index ea957e7ad2..ca0d1446f5 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 -Removes the specified project. +experimental: Removes the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProject diff --git a/docs/command/atlas-api-projects-deleteProjectInvitation.txt b/docs/command/atlas-api-projects-deleteProjectInvitation.txt index 27295b2162..7346601a47 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 -Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. +experimental: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteProjectInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectInvitation diff --git a/docs/command/atlas-api-projects-deleteProjectLimit.txt b/docs/command/atlas-api-projects-deleteProjectLimit.txt index abfda5af65..4acda5aa63 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 -Removes the specified project limit. +experimental: Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteProjectLimit'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectLimit diff --git a/docs/command/atlas-api-projects-getProject.txt b/docs/command/atlas-api-projects-getProject.txt index a2bbe18655..7fdba1618e 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 -Returns details about the specified project. +experimental: Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProject diff --git a/docs/command/atlas-api-projects-getProjectByName.txt b/docs/command/atlas-api-projects-getProjectByName.txt index f65efdaee6..5c21198d3f 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 -Returns details about the specified project. +experimental: Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getProjectByName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectByName diff --git a/docs/command/atlas-api-projects-getProjectInvitation.txt b/docs/command/atlas-api-projects-getProjectInvitation.txt index 162d6b506d..0f275cf44e 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 -Returns the details of one pending invitation to the specified project. +experimental: Returns the details of one pending invitation to the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getProjectInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectInvitation diff --git a/docs/command/atlas-api-projects-getProjectLimit.txt b/docs/command/atlas-api-projects-getProjectLimit.txt index fd42e03b59..baa4957100 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 -Returns the specified limit for the specified project. +experimental: Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getProjectLimit'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLimit diff --git a/docs/command/atlas-api-projects-getProjectLtsVersions.txt b/docs/command/atlas-api-projects-getProjectLtsVersions.txt index 0c943d45f8..7387e932b0 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 -Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. +experimental: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. This command is invoking the endpoint with OperationID: 'getProjectLtsVersions'. For more information about flags, format of --file and examples, see: 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 d5cd760e75..6ad98f9e4e 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 -Returns details about the specified project's settings. +experimental: Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getProjectSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectSettings diff --git a/docs/command/atlas-api-projects-listProjectInvitations.txt b/docs/command/atlas-api-projects-listProjectInvitations.txt index a2bf76e50a..6583902f40 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 -Returns all pending invitations to the specified project. +experimental: Returns all pending invitations to the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'listProjectInvitations'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectInvitations diff --git a/docs/command/atlas-api-projects-listProjectLimits.txt b/docs/command/atlas-api-projects-listProjectLimits.txt index e1b5bc6232..0426365e51 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 -Returns all the limits for the specified project. +experimental: Returns all the limits for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listProjectLimits'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectLimits diff --git a/docs/command/atlas-api-projects-listProjectUsers.txt b/docs/command/atlas-api-projects-listProjectUsers.txt index ccf98fe4b4..5860b2128f 100644 --- a/docs/command/atlas-api-projects-listProjectUsers.txt +++ b/docs/command/atlas-api-projects-listProjectUsers.txt @@ -12,7 +12,7 @@ atlas api projects listProjectUsers :depth: 1 :class: singlecol -Returns details about all users in the specified project. +experimental: Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listProjectUsers'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectUsers diff --git a/docs/command/atlas-api-projects-listProjects.txt b/docs/command/atlas-api-projects-listProjects.txt index 50cd17ea60..b91a56074b 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 -Returns details about all projects. +experimental: Returns details about all projects. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Organization Read Only role or higher. This command is invoking the endpoint with OperationID: 'listProjects'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjects diff --git a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt b/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt index c32ab51cf9..2ccd5dff3f 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 -Migrates a project from its current organization to another organization. +experimental: Migrates a project from its current organization to another organization. All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'migrateProjectToAnotherOrg'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/migrateProjectToAnotherOrg diff --git a/docs/command/atlas-api-projects-removeProjectUser.txt b/docs/command/atlas-api-projects-removeProjectUser.txt index 003ba3e18a..6dc98010d7 100644 --- a/docs/command/atlas-api-projects-removeProjectUser.txt +++ b/docs/command/atlas-api-projects-removeProjectUser.txt @@ -12,7 +12,7 @@ atlas api projects removeProjectUser :depth: 1 :class: singlecol -Removes the specified user from the specified project. +experimental: Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'removeProjectUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/removeProjectUser diff --git a/docs/command/atlas-api-projects-returnAllIpAddresses.txt b/docs/command/atlas-api-projects-returnAllIpAddresses.txt index 6e100422e9..4e7aaec452 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 -Returns all IP addresses for this project. +experimental: Returns all IP addresses for this project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'returnAllIpAddresses'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/returnAllIpAddresses diff --git a/docs/command/atlas-api-projects-setProjectLimit.txt b/docs/command/atlas-api-projects-setProjectLimit.txt index b223a70f8e..6799eeef41 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 -Sets the specified project limit. +experimental: Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role. NOTE: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern. This command is invoking the endpoint with OperationID: 'setProjectLimit'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/setProjectLimit diff --git a/docs/command/atlas-api-projects-updateProject.txt b/docs/command/atlas-api-projects-updateProject.txt index 1c1decd52e..a0dac8c76c 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 -Updates the human-readable label that identifies the specified project, or the tags associated with the project. +experimental: Updates the human-readable label that identifies the specified project, or the tags associated with the project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProject diff --git a/docs/command/atlas-api-projects-updateProjectInvitation.txt b/docs/command/atlas-api-projects-updateProjectInvitation.txt index adcc17c4ee..6f87c2020b 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 -Updates the details of one pending invitation to the specified project. +experimental: Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateProjectInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitation diff --git a/docs/command/atlas-api-projects-updateProjectInvitationById.txt b/docs/command/atlas-api-projects-updateProjectInvitationById.txt index d5e51e2af6..250771a0d8 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 -Updates the details of one pending invitation to the specified project. +experimental: Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateProjectInvitationById'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitationById diff --git a/docs/command/atlas-api-projects-updateProjectRoles.txt b/docs/command/atlas-api-projects-updateProjectRoles.txt index dfbac26db7..234fb5c504 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 -Updates the roles of the specified user in the specified project. +experimental: Updates the roles of the specified user in the specified project. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting API Key must have the Group User Admin role. This command is invoking the endpoint with OperationID: 'updateProjectRoles'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectRoles diff --git a/docs/command/atlas-api-projects-updateProjectSettings.txt b/docs/command/atlas-api-projects-updateProjectSettings.txt index 26b3ebcfaa..32f7bb095b 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 -Updates the settings of the specified project. +experimental: Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateProjectSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectSettings diff --git a/docs/command/atlas-api-projects.txt b/docs/command/atlas-api-projects.txt index bf5942cd05..5601192d06 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 -Returns, adds, and edits collections of clusters and users in MongoDB Cloud. +experimental: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. Options ------- @@ -49,31 +49,31 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projects-addUserToProject` - Adds one MongoDB Cloud user to the specified project. -* :ref:`atlas-api-projects-createProject` - Creates one project. -* :ref:`atlas-api-projects-createProjectInvitation` - Invites one MongoDB Cloud user to join the specified project. -* :ref:`atlas-api-projects-deleteProject` - Removes the specified project. -* :ref:`atlas-api-projects-deleteProjectInvitation` - Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. -* :ref:`atlas-api-projects-deleteProjectLimit` - Removes the specified project limit. -* :ref:`atlas-api-projects-getProject` - Returns details about the specified project. -* :ref:`atlas-api-projects-getProjectByName` - Returns details about the specified project. -* :ref:`atlas-api-projects-getProjectInvitation` - Returns the details of one pending invitation to the specified project. -* :ref:`atlas-api-projects-getProjectLimit` - Returns the specified limit for the specified project. -* :ref:`atlas-api-projects-getProjectLtsVersions` - Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. -* :ref:`atlas-api-projects-getProjectSettings` - Returns details about the specified project's settings. -* :ref:`atlas-api-projects-listProjectInvitations` - Returns all pending invitations to the specified project. -* :ref:`atlas-api-projects-listProjectLimits` - Returns all the limits for the specified project. -* :ref:`atlas-api-projects-listProjectUsers` - Returns details about all users in the specified project. -* :ref:`atlas-api-projects-listProjects` - Returns details about all projects. -* :ref:`atlas-api-projects-migrateProjectToAnotherOrg` - Migrates a project from its current organization to another organization. -* :ref:`atlas-api-projects-removeProjectUser` - Removes the specified user from the specified project. -* :ref:`atlas-api-projects-returnAllIpAddresses` - Returns all IP addresses for this project. -* :ref:`atlas-api-projects-setProjectLimit` - Sets the specified project limit. -* :ref:`atlas-api-projects-updateProject` - Updates the human-readable label that identifies the specified project, or the tags associated with the project. -* :ref:`atlas-api-projects-updateProjectInvitation` - Updates the details of one pending invitation to the specified project. -* :ref:`atlas-api-projects-updateProjectInvitationById` - Updates the details of one pending invitation to the specified project. -* :ref:`atlas-api-projects-updateProjectRoles` - Updates the roles of the specified user in the specified project. -* :ref:`atlas-api-projects-updateProjectSettings` - Updates the settings of the specified project. +* :ref:`atlas-api-projects-addUserToProject` - experimental: Adds one MongoDB Cloud user to the specified project. +* :ref:`atlas-api-projects-createProject` - experimental: Creates one project. +* :ref:`atlas-api-projects-createProjectInvitation` - experimental: Invites one MongoDB Cloud user to join the specified project. +* :ref:`atlas-api-projects-deleteProject` - experimental: Removes the specified project. +* :ref:`atlas-api-projects-deleteProjectInvitation` - experimental: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. +* :ref:`atlas-api-projects-deleteProjectLimit` - experimental: Removes the specified project limit. +* :ref:`atlas-api-projects-getProject` - experimental: Returns details about the specified project. +* :ref:`atlas-api-projects-getProjectByName` - experimental: Returns details about the specified project. +* :ref:`atlas-api-projects-getProjectInvitation` - experimental: Returns the details of one pending invitation to the specified project. +* :ref:`atlas-api-projects-getProjectLimit` - experimental: Returns the specified limit for the specified project. +* :ref:`atlas-api-projects-getProjectLtsVersions` - experimental: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. +* :ref:`atlas-api-projects-getProjectSettings` - experimental: Returns details about the specified project's settings. +* :ref:`atlas-api-projects-listProjectInvitations` - experimental: Returns all pending invitations to the specified project. +* :ref:`atlas-api-projects-listProjectLimits` - experimental: Returns all the limits for the specified project. +* :ref:`atlas-api-projects-listProjectUsers` - experimental: Returns details about all users in the specified project. +* :ref:`atlas-api-projects-listProjects` - experimental: Returns details about all projects. +* :ref:`atlas-api-projects-migrateProjectToAnotherOrg` - experimental: Migrates a project from its current organization to another organization. +* :ref:`atlas-api-projects-removeProjectUser` - experimental: Removes the specified user from the specified project. +* :ref:`atlas-api-projects-returnAllIpAddresses` - experimental: Returns all IP addresses for this project. +* :ref:`atlas-api-projects-setProjectLimit` - experimental: Sets the specified project limit. +* :ref:`atlas-api-projects-updateProject` - experimental: Updates the human-readable label that identifies the specified project, or the tags associated with the project. +* :ref:`atlas-api-projects-updateProjectInvitation` - experimental: Updates the details of one pending invitation to the specified project. +* :ref:`atlas-api-projects-updateProjectInvitationById` - experimental: Updates the details of one pending invitation to the specified project. +* :ref:`atlas-api-projects-updateProjectRoles` - experimental: Updates the roles of the specified user in the specified project. +* :ref:`atlas-api-projects-updateProjectSettings` - experimental: 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 f495455426..3af6ea4b69 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 -Configures the project level settings for the push-based log export feature. +experimental: Configures the project level settings for the push-based log export feature. This command is invoking the endpoint with OperationID: 'createPushBasedLogConfiguration'. For more information about flags, format of --file and examples, see: 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 48417bd0a3..f6607bc538 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 -Disables the push-based log export feature by resetting the project level settings to its default configuration. +experimental: Disables the push-based log export feature by resetting the project level settings to its default configuration. This command is invoking the endpoint with OperationID: 'deletePushBasedLogConfiguration'. For more information about flags, format of --file and examples, see: 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 0fcb622cc4..ca57a1769c 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 -Fetches the current project level settings for the push-based log export feature. +experimental: Fetches the current project level settings for the push-based log export feature. This command is invoking the endpoint with OperationID: 'getPushBasedLogConfiguration'. For more information about flags, format of --file and examples, see: 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 f83fc1f38d..37dbee0597 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 -Updates the project level settings for the push-based log export feature. +experimental: Updates the project level settings for the push-based log export feature. This command is invoking the endpoint with OperationID: 'updatePushBasedLogConfiguration'. For more information about flags, format of --file and examples, see: 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 681ae65512..bbee2f8a81 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 -You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. +experimental: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes. @@ -51,10 +51,10 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-pushBasedLogExport-createPushBasedLogConfiguration` - Configures the project level settings for the push-based log export feature. -* :ref:`atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration` - Disables the push-based log export feature by resetting the project level settings to its default configuration. -* :ref:`atlas-api-pushBasedLogExport-getPushBasedLogConfiguration` - Fetches the current project level settings for the push-based log export feature. -* :ref:`atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration` - Updates the project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-createPushBasedLogConfiguration` - experimental: Configures the project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration` - experimental: Disables the push-based log export feature by resetting the project level settings to its default configuration. +* :ref:`atlas-api-pushBasedLogExport-getPushBasedLogConfiguration` - experimental: Fetches the current project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration` - experimental: 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 7edc1b934f..1964e20985 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 -Create one Atlas Resource Policy for an org. +experimental: Create one Atlas Resource Policy for an org. This command is invoking the endpoint with OperationID: 'createAtlasResourcePolicy'. For more information about flags, format of --file and examples, see: 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 125b33739d..46607e9731 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 -Delete one Atlas Resource Policy for an org. +experimental: Delete one Atlas Resource Policy for an org. This command is invoking the endpoint with OperationID: 'deleteAtlasResourcePolicy'. For more information about flags, format of --file and examples, see: 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 a8ad1b8821..80525e849e 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 -Return all Atlas Resource Policies for the org. +experimental: Return all Atlas Resource Policies for the org. This command is invoking the endpoint with OperationID: 'getAtlasResourcePolicies'. For more information about flags, format of --file and examples, see: 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 8dd3d82c7a..d93db429e3 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 -Return one Atlas Resource Policy for an org. +experimental: Return one Atlas Resource Policy for an org. This command is invoking the endpoint with OperationID: 'getAtlasResourcePolicy'. For more information about flags, format of --file and examples, see: 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 3cb0efe64d..c284db07d0 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 -Return all non-compliant resources for an org. +experimental: Return all non-compliant resources for an org. This command is invoking the endpoint with OperationID: 'getResourcesNonCompliant'. For more information about flags, format of --file and examples, see: 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 cb942702e9..19bea4e391 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 -Update one Atlas Resource Policy for an org. +experimental: Update one Atlas Resource Policy for an org. This command is invoking the endpoint with OperationID: 'updateAtlasResourcePolicy'. For more information about flags, format of --file and examples, see: 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 384cb90afe..21d5aee8aa 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 -Validate one Atlas Resource Policy for an org. +experimental: Validate one Atlas Resource Policy for an org. This command is invoking the endpoint with OperationID: 'validateAtlasResourcePolicy'. For more information about flags, format of --file and examples, see: 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 444079a73c..136e70c518 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 -Configure and manage Atlas Resource Policies within your organization. +experimental: Configure and manage Atlas Resource Policies within your organization. Options ------- @@ -49,13 +49,13 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-resourcePolicies-createAtlasResourcePolicy` - Create one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-deleteAtlasResourcePolicy` - Delete one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicies` - Return all Atlas Resource Policies for the org. -* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicy` - Return one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getResourcesNonCompliant` - Return all non-compliant resources for an org. -* :ref:`atlas-api-resourcePolicies-updateAtlasResourcePolicy` - Update one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-validateAtlasResourcePolicy` - Validate one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-createAtlasResourcePolicy` - experimental: Create one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-deleteAtlasResourcePolicy` - experimental: Delete one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicies` - experimental: Return all Atlas Resource Policies for the org. +* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicy` - experimental: Return one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-getResourcesNonCompliant` - experimental: Return all non-compliant resources for an org. +* :ref:`atlas-api-resourcePolicies-updateAtlasResourcePolicy` - experimental: Update one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-validateAtlasResourcePolicy` - experimental: 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 6d2182ca07..8a6a76f7f8 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 -Creates an index on the cluster identified by its name in a rolling manner. +experimental: Creates an index on the cluster identified by its name in a rolling manner. Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'createRollingIndex'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Rolling-Index/operation/createRollingIndex diff --git a/docs/command/atlas-api-rollingIndex.txt b/docs/command/atlas-api-rollingIndex.txt index 3e1cd97406..6a1465cbc8 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 -Creates one index to a database deployment in a rolling manner. +experimental: 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 +51,7 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-rollingIndex-createRollingIndex` - Creates an index on the cluster identified by its name in a rolling manner. +* :ref:`atlas-api-rollingIndex-createRollingIndex` - experimental: 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 d5b7c130f8..f9a85ed69b 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 -This resource returns information about the MongoDB application along with API key meta data. +experimental: This resource returns information about the MongoDB application along with API key meta data. This command is invoking the endpoint with OperationID: 'getSystemStatus'. For more information about flags, format of --file and examples, see: 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 7419f1ca7c..b94385c5c2 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 -Returns all control plane IP addresses. +experimental: Returns all control plane IP addresses. This command is invoking the endpoint with OperationID: 'returnAllControlPlaneIpAddresses'. For more information about flags, format of --file and examples, see: 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 00f2658f32..63139ae055 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 -Returns details that describe the MongoDB Cloud build and the access token that requests this resource. +experimental: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API. @@ -51,8 +51,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-root-getSystemStatus` - This resource returns information about the MongoDB application along with API key meta data. -* :ref:`atlas-api-root-returnAllControlPlaneIpAddresses` - Returns all control plane IP addresses. +* :ref:`atlas-api-root-getSystemStatus` - experimental: This resource returns information about the MongoDB application along with API key meta data. +* :ref:`atlas-api-root-returnAllControlPlaneIpAddresses` - experimental: 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 ab97b96a0b..a1b4d20fc0 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 -Creates one serverless instance in the specified project. +experimental: Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createServerlessInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance diff --git a/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt index 24def2d0c2..00da1455af 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 -Removes one serverless instance from the specified project. +experimental: Removes one serverless instance from the specified project. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteServerlessInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/deleteServerlessInstance diff --git a/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt index db4bc4bb35..b8086fa778 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 -Returns details for one serverless instance in the specified project. +experimental: Returns details for one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getServerlessInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/getServerlessInstance diff --git a/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt b/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt index 5ec3fa9b53..dbd360bb96 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 -Returns details for all serverless instances in the specified project. +experimental: Returns details for all serverless instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listServerlessInstances'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/listServerlessInstances diff --git a/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt index 9c955722b3..007fc82495 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 -Updates one serverless instance in the specified project. +experimental: Updates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateServerlessInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/updateServerlessInstance diff --git a/docs/command/atlas-api-serverlessInstances.txt b/docs/command/atlas-api-serverlessInstances.txt index 71e6d989f9..479550b38d 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 -Returns, adds, edits, and removes serverless instances. +experimental: Returns, adds, edits, and removes serverless instances. Options ------- @@ -49,11 +49,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serverlessInstances-createServerlessInstance` - Creates one serverless instance in the specified project. -* :ref:`atlas-api-serverlessInstances-deleteServerlessInstance` - Removes one serverless instance from the specified project. -* :ref:`atlas-api-serverlessInstances-getServerlessInstance` - Returns details for one serverless instance in the specified project. -* :ref:`atlas-api-serverlessInstances-listServerlessInstances` - Returns details for all serverless instances in the specified project. -* :ref:`atlas-api-serverlessInstances-updateServerlessInstance` - Updates one serverless instance in the specified project. +* :ref:`atlas-api-serverlessInstances-createServerlessInstance` - experimental: Creates one serverless instance in the specified project. +* :ref:`atlas-api-serverlessInstances-deleteServerlessInstance` - experimental: Removes one serverless instance from the specified project. +* :ref:`atlas-api-serverlessInstances-getServerlessInstance` - experimental: Returns details for one serverless instance in the specified project. +* :ref:`atlas-api-serverlessInstances-listServerlessInstances` - experimental: Returns details for all serverless instances in the specified project. +* :ref:`atlas-api-serverlessInstances-updateServerlessInstance` - experimental: 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 e4014e785c..937809677c 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 -Creates one private endpoint for one serverless instance. +experimental: Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance. This command is invoking the endpoint with OperationID: 'createServerlessPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/createServerlessPrivateEndpoint diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt index 959b339387..88ef894569 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 -Remove one private endpoint from one serverless instance. +experimental: Remove one private endpoint from one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteServerlessPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/deleteServerlessPrivateEndpoint diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt index 65cfca5b8a..1e752cfff9 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 -Return one private endpoint for one serverless instance. +experimental: Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. This command is invoking the endpoint with OperationID: 'getServerlessPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/getServerlessPrivateEndpoint diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt index 825ff0f560..e752f068c9 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 -Returns all private endpoints for one serverless instance. +experimental: Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource. This command is invoking the endpoint with OperationID: 'listServerlessPrivateEndpoints'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/listServerlessPrivateEndpoints diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt index 68c52831c9..367dca6425 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 -Updates one private endpoint for one serverless instance. +experimental: Updates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateServerlessPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/updateServerlessPrivateEndpoint diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints.txt b/docs/command/atlas-api-serverlessPrivateEndpoints.txt index 5bbbd72a5f..de3d7016c7 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 -Returns, adds, edits, and removes private endpoints for serverless instances. +experimental: 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 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint` - Creates one private endpoint for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint` - Remove one private endpoint from one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint` - Return one private endpoint for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints` - Returns all private endpoints for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint` - Updates one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint` - experimental: Creates one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint` - experimental: Remove one private endpoint from one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint` - experimental: Return one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints` - experimental: Returns all private endpoints for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint` - experimental: 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 d3a09c8a65..9df8b781f5 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 -Assigns the specified Service Account to the specified Project. +experimental: Assigns the specified Service Account to the specified Project. Available as a preview feature. This command is invoking the endpoint with OperationID: 'addProjectServiceAccount'. For more information about flags, format of --file and examples, see: 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 1595e2b2f5..7dc79e0c40 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 -Creates one Service Account for the specified Project. +experimental: Creates one Service Account for the specified Project. The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. Available as a preview feature. This command is invoking the endpoint with OperationID: 'createProjectServiceAccount'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccount diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt index 41fe96e8a2..fd28fead00 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 -Add Access List Entries for the specified Service Account for the project. +experimental: Add Access List Entries for the specified Service Account for the project. Resources require all API requests to originate from IP addresses on the API access list. Available as a preview feature. This command is invoking the endpoint with OperationID: 'createProjectServiceAccountAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountAccessList diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt index ed52b5aab2..ee1e6d8ec7 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 -Create a secret for the specified Service Account in the specified Project. +experimental: Create a secret for the specified Service Account in the specified Project. Available as a preview feature. This command is invoking the endpoint with OperationID: 'createProjectServiceAccountSecret'. For more information about flags, format of --file and examples, see: 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 c62af6b4d8..8d02d74b35 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 -Creates one Service Account for the specified Organization. +experimental: Creates one Service Account for the specified Organization. Available as a preview feature. This command is invoking the endpoint with OperationID: 'createServiceAccount'. For more information about flags, format of --file and examples, see: 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 3d3b7b701a..9baafed309 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 -Add Access List Entries for the specified Service Account for the organization. +experimental: 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. Available as a preview feature. This command is invoking the endpoint with OperationID: 'createServiceAccountAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountAccessList diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt index fcd482bb2b..f3330bffcb 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 -Create a secret for the specified Service Account. +experimental: Create a secret for the specified Service Account. Available as a preview feature. This command is invoking the endpoint with OperationID: 'createServiceAccountSecret'. For more information about flags, format of --file and examples, see: 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 6c4cd5be08..8f66740fce 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 -Removes the specified Service Account from the specified project. +experimental: Removes the specified Service Account from the specified project. The Service Account will still be a part of the Organization it was created in, and the credentials will remain active until expired or manually revoked. Available as a preview feature. This command is invoking the endpoint with OperationID: 'deleteProjectServiceAccount'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccount diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt index a2110dbf3e..dab82845f3 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 -Removes the specified access list entry from the specified Service Account for the project. +experimental: Removes the specified access list entry from the specified Service Account for the project. You can't remove the requesting IP address from the access list. Available as a preview feature. This command is invoking the endpoint with OperationID: 'deleteProjectServiceAccountAccessListEntry'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountAccessListEntry diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt index 9370bf76ec..107ba8af20 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 -Deletes the specified Service Account secret. +experimental: Deletes the specified Service Account secret. Available as a preview feature. This command is invoking the endpoint with OperationID: 'deleteProjectServiceAccountSecret'. For more information about flags, format of --file and examples, see: 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 a07212b569..dce2e70b86 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 -Deletes the specified Service Account. +experimental: Deletes the specified Service Account. Available as a preview feature. This command is invoking the endpoint with OperationID: 'deleteServiceAccount'. For more information about flags, format of --file and examples, see: 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 a797746ed2..1c3f6ce45a 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 -Removes the specified access list entry from the specified Service Account for the organization. +experimental: 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. Available as a preview feature. This command is invoking the endpoint with OperationID: 'deleteServiceAccountAccessListEntry'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountAccessListEntry diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt index 3c5d0069e5..7f61d8452b 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 -Deletes the specified Service Account secret. +experimental: Deletes the specified Service Account secret. Available as a preview feature. This command is invoking the endpoint with OperationID: 'deleteServiceAccountSecret'. For more information about flags, format of --file and examples, see: 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 64f53a43c6..09d0c51ac1 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 -Returns one Service Account in the specified Project. +experimental: Returns one Service Account in the specified Project. Available as a preview feature. This command is invoking the endpoint with OperationID: 'getProjectServiceAccount'. For more information about flags, format of --file and examples, see: 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 914751914f..6efaa56ecb 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 -Returns the specified Service Account. +experimental: Returns the specified Service Account. Available as a preview feature. This command is invoking the endpoint with OperationID: 'getServiceAccount'. For more information about flags, format of --file and examples, see: 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 e0d72b8c1c..d99adb8cad 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 -Returns all access list entries that you configured for the specified Service Account for the project. +experimental: Returns all access list entries that you configured for the specified Service Account for the project. Available as a preview feature. This command is invoking the endpoint with OperationID: 'listProjectServiceAccountAccessList'. For more information about flags, format of --file and examples, see: 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 343792e0bc..91a1209982 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 -Returns all Service Accounts for the specified Project. +experimental: Returns all Service Accounts for the specified Project. Available as a preview feature. This command is invoking the endpoint with OperationID: 'listProjectServiceAccounts'. For more information about flags, format of --file and examples, see: 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 e496d893cf..ade1546555 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 -Returns all access list entries that you configured for the specified Service Account for the organization. +experimental: Returns all access list entries that you configured for the specified Service Account for the organization. Available as a preview feature. This command is invoking the endpoint with OperationID: 'listServiceAccountAccessList'. For more information about flags, format of --file and examples, see: 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 e80b999014..5e2d72bf36 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 -Returns a list of all projects the specified Service Account is a part of. +experimental: Returns a list of all projects the specified Service Account is a part of. Available as a preview feature. This command is invoking the endpoint with OperationID: 'listServiceAccountProjects'. For more information about flags, format of --file and examples, see: 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 65d43d3998..e380cc7732 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 -Returns all Service Accounts for the specified Organization. +experimental: Returns all Service Accounts for the specified Organization. Available as a preview feature. This command is invoking the endpoint with OperationID: 'listServiceAccounts'. For more information about flags, format of --file and examples, see: 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 d0d4c41c04..d8c20ad95d 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 -Updates one Service Account in the specified Project. +experimental: Updates one Service Account in the specified Project. Available as a preview feature. This command is invoking the endpoint with OperationID: 'updateProjectServiceAccount'. For more information about flags, format of --file and examples, see: 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 c597917d97..39967d9d42 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 -Updates the specified Service Account in the specified Organization. +experimental: Updates the specified Service Account in the specified Organization. Available as a preview feature. This command is invoking the endpoint with OperationID: 'updateServiceAccount'. For more information about flags, format of --file and examples, see: 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 02de8a0306..5c14bdd3a8 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 -Endpoints for managing Service Accounts and secrets. +experimental: Endpoints for managing Service Accounts and secrets. Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow. This feature is available as a Preview feature. @@ -51,28 +51,28 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serviceAccounts-addProjectServiceAccount` - Assigns the specified Service Account to the specified Project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccount` - Creates one Service Account for the specified Project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountAccessList` - Add Access List Entries for the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountSecret` - Create a secret for the specified Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-createServiceAccount` - Creates one Service Account for the specified Organization. -* :ref:`atlas-api-serviceAccounts-createServiceAccountAccessList` - Add Access List Entries for the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-createServiceAccountSecret` - Create a secret for the specified Service Account. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccount` - Removes the specified Service Account from the specified project. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry` - Removes the specified access list entry from the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountSecret` - Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccount` - Deletes the specified Service Account. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry` - Removes the specified access list entry from the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccountSecret` - Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-getProjectServiceAccount` - Returns one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-getServiceAccount` - Returns the specified Service Account. -* :ref:`atlas-api-serviceAccounts-listProjectServiceAccountAccessList` - Returns all access list entries that you configured for the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-listProjectServiceAccounts` - Returns all Service Accounts for the specified Project. -* :ref:`atlas-api-serviceAccounts-listServiceAccountAccessList` - Returns all access list entries that you configured for the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-listServiceAccountProjects` - Returns a list of all projects the specified Service Account is a part of. -* :ref:`atlas-api-serviceAccounts-listServiceAccounts` - Returns all Service Accounts for the specified Organization. -* :ref:`atlas-api-serviceAccounts-updateProjectServiceAccount` - Updates one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-updateServiceAccount` - Updates the specified Service Account in the specified Organization. +* :ref:`atlas-api-serviceAccounts-addProjectServiceAccount` - experimental: Assigns the specified Service Account to the specified Project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccount` - experimental: Creates one Service Account for the specified Project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountAccessList` - experimental: Add Access List Entries for the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountSecret` - experimental: Create a secret for the specified Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-createServiceAccount` - experimental: Creates one Service Account for the specified Organization. +* :ref:`atlas-api-serviceAccounts-createServiceAccountAccessList` - experimental: Add Access List Entries for the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-createServiceAccountSecret` - experimental: Create a secret for the specified Service Account. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccount` - experimental: Removes the specified Service Account from the specified project. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry` - experimental: Removes the specified access list entry from the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountSecret` - experimental: Deletes the specified Service Account secret. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccount` - experimental: Deletes the specified Service Account. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry` - experimental: Removes the specified access list entry from the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccountSecret` - experimental: Deletes the specified Service Account secret. +* :ref:`atlas-api-serviceAccounts-getProjectServiceAccount` - experimental: Returns one Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-getServiceAccount` - experimental: Returns the specified Service Account. +* :ref:`atlas-api-serviceAccounts-listProjectServiceAccountAccessList` - experimental: Returns all access list entries that you configured for the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-listProjectServiceAccounts` - experimental: Returns all Service Accounts for the specified Project. +* :ref:`atlas-api-serviceAccounts-listServiceAccountAccessList` - experimental: Returns all access list entries that you configured for the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-listServiceAccountProjects` - experimental: Returns a list of all projects the specified Service Account is a part of. +* :ref:`atlas-api-serviceAccounts-listServiceAccounts` - experimental: Returns all Service Accounts for the specified Organization. +* :ref:`atlas-api-serviceAccounts-updateProjectServiceAccount` - experimental: Updates one Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-updateServiceAccount` - experimental: 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 588c1bd5d8..47fa2dbcb1 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 -Restores the specified cluster. +experimental: Restores the specified cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createSharedClusterBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/createSharedClusterBackupRestoreJob diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt b/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt index b1cabd2bc6..88065e55db 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 -Returns the specified restore job. +experimental: Returns the specified restore job. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getSharedClusterBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/getSharedClusterBackupRestoreJob diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt b/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt index fa05d1f744..0730260470 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 -Returns all restore jobs for the specified M2 or M5 cluster. +experimental: Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listSharedClusterBackupRestoreJobs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/listSharedClusterBackupRestoreJobs diff --git a/docs/command/atlas-api-sharedTierRestoreJobs.txt b/docs/command/atlas-api-sharedTierRestoreJobs.txt index bbf7384dc8..9e2f32b8d5 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 -Returns and adds restore jobs for shared-tier database deployments. +experimental: Returns and adds restore jobs for shared-tier database deployments. Options ------- @@ -49,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob` - Restores the specified cluster. -* :ref:`atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob` - Returns the specified restore job. -* :ref:`atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs` - Returns all restore jobs for the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob` - experimental: Restores the specified cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob` - experimental: Returns the specified restore job. +* :ref:`atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs` - experimental: 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 b1a11d9eb7..c61d7123f8 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 -Requests one snapshot for the specified shared cluster. +experimental: Requests one snapshot for the specified shared cluster. This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'downloadSharedClusterBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/downloadSharedClusterBackup diff --git a/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt b/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt index ffcc9f2192..8438a7caad 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 -Returns details for one snapshot for the specified shared cluster. +experimental: Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getSharedClusterBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/getSharedClusterBackup diff --git a/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt b/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt index adf9620826..f894724046 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 -Returns details for all snapshots for the specified shared cluster. +experimental: Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listSharedClusterBackups'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/listSharedClusterBackups diff --git a/docs/command/atlas-api-sharedTierSnapshots.txt b/docs/command/atlas-api-sharedTierSnapshots.txt index 8c902f18e3..ebc883786e 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 -Returns and requests to download shared-tier database deployment snapshots. +experimental: Returns and requests to download shared-tier database deployment snapshots. Options ------- @@ -49,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierSnapshots-downloadSharedClusterBackup` - Requests one snapshot for the specified shared cluster. -* :ref:`atlas-api-sharedTierSnapshots-getSharedClusterBackup` - Returns details for one snapshot for the specified shared cluster. -* :ref:`atlas-api-sharedTierSnapshots-listSharedClusterBackups` - Returns details for all snapshots for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-downloadSharedClusterBackup` - experimental: Requests one snapshot for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-getSharedClusterBackup` - experimental: Returns details for one snapshot for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-listSharedClusterBackups` - experimental: 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 88b6fcd6d0..770122c1a2 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 -Requests the acceptance of an incoming VPC Peering connection. +experimental: Requests the acceptance of an incoming VPC Peering connection. This command is invoking the endpoint with OperationID: 'acceptVpcPeeringConnection'. For more information about flags, format of --file and examples, see: 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 6ea7647a61..2ff41904a7 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 -Creates one Private Link in the specified project. +experimental: Creates one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'createPrivateLinkConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createPrivateLinkConnection diff --git a/docs/command/atlas-api-streams-createStreamConnection.txt b/docs/command/atlas-api-streams-createStreamConnection.txt index dcb2bce95b..1942d5d70d 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 -Creates one connection for a stream instance in the specified project. +experimental: Creates one connection for a stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'createStreamConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamConnection diff --git a/docs/command/atlas-api-streams-createStreamInstance.txt b/docs/command/atlas-api-streams-createStreamInstance.txt index e8c65f0573..c30d372a17 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 -Creates one stream instance in the specified project. +experimental: Creates one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'createStreamInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstance diff --git a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt b/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt index 747b6f50dc..2bb9d8def9 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 -Creates one stream instance in the specified project with sample connections. +experimental: Creates one stream instance in the specified project with sample connections. To use this resource the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'createStreamInstanceWithSampleConnections'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstanceWithSampleConnections diff --git a/docs/command/atlas-api-streams-createStreamProcessor.txt b/docs/command/atlas-api-streams-createStreamProcessor.txt index 4a99df82c8..3e6c711f85 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 -Create one Stream Processor within the specified stream instance. +experimental: Create one Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'createStreamProcessor'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamProcessor diff --git a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt index 1fed5b241c..4a2af1653f 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 -Deletes one Private Link in the specified project. +experimental: Deletes one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'deletePrivateLinkConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deletePrivateLinkConnection diff --git a/docs/command/atlas-api-streams-deleteStreamConnection.txt b/docs/command/atlas-api-streams-deleteStreamConnection.txt index ee2944b923..22c59dcfd2 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 -Delete one connection of the specified stream instance. +experimental: Delete one connection of the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'deleteStreamConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamConnection diff --git a/docs/command/atlas-api-streams-deleteStreamInstance.txt b/docs/command/atlas-api-streams-deleteStreamInstance.txt index 24004e5429..128c879dce 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 -Delete one stream instance in the specified project. +experimental: Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'deleteStreamInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamInstance diff --git a/docs/command/atlas-api-streams-deleteStreamProcessor.txt b/docs/command/atlas-api-streams-deleteStreamProcessor.txt index 1a9bad3ca6..921498a537 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 -Delete a Stream Processor within the specified stream instance. +experimental: Delete a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'deleteStreamProcessor'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamProcessor diff --git a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt index 997ec64f5a..d4312aff64 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 -Deletes an incoming VPC Peering connection. +experimental: Deletes an incoming VPC Peering connection. This command is invoking the endpoint with OperationID: 'deleteVpcPeeringConnection'. For more information about flags, format of --file and examples, see: 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 17d4a1203b..b4f163371b 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 -Downloads the audit logs for the specified Atlas Streams Processing instance. +experimental: Downloads the audit logs for the specified Atlas Streams Processing instance. By default, logs cover periods of 30 days. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". This command is invoking the endpoint with OperationID: 'downloadStreamTenantAuditLogs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/downloadStreamTenantAuditLogs diff --git a/docs/command/atlas-api-streams-getAccountDetails.txt b/docs/command/atlas-api-streams-getAccountDetails.txt index 5491b7e56e..94af8fd7d6 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 -Returns the Account ID, and the VPC ID for the group and region specified. +experimental: Returns the Account ID, and the VPC ID for the group and region specified. This command is invoking the endpoint with OperationID: 'getAccountDetails'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getAccountDetails diff --git a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt index f49d521244..e1fb47dc66 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 -Returns the details of one Private Link connection within the project. +experimental: Returns the details of one Private Link connection within the project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPrivateLinkConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getPrivateLinkConnection diff --git a/docs/command/atlas-api-streams-getStreamConnection.txt b/docs/command/atlas-api-streams-getStreamConnection.txt index e0328fa0d2..c10bc38d1b 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 -Returns the details of one stream connection within the specified stream instance. +experimental: Returns the details of one stream connection within the specified stream instance. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getStreamConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamConnection diff --git a/docs/command/atlas-api-streams-getStreamInstance.txt b/docs/command/atlas-api-streams-getStreamInstance.txt index 7ad1c03881..d0c31a2f79 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 -Returns the details of one stream instance within the specified project. +experimental: Returns the details of one stream instance within the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'getStreamInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamInstance diff --git a/docs/command/atlas-api-streams-getStreamProcessor.txt b/docs/command/atlas-api-streams-getStreamProcessor.txt index 2d19476b6a..8afcbe0274 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 -Get one Stream Processor within the specified stream instance. +experimental: Get one Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'getStreamProcessor'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamProcessor diff --git a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getVpcPeeringConnections.txt index 9ba6094cb0..e9ccdcb4c4 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 -Returns a list of incoming VPC Peering Connections. +experimental: Returns a list of incoming VPC Peering Connections. This command is invoking the endpoint with OperationID: 'getVpcPeeringConnections'. For more information about flags, format of --file and examples, see: 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 e2a1ca825d..5ceb6b3a6d 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 -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. +experimental: 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. This command is invoking the endpoint with OperationID: 'listPrivateLinkConnections'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listPrivateLinkConnections diff --git a/docs/command/atlas-api-streams-listStreamConnections.txt b/docs/command/atlas-api-streams-listStreamConnections.txt index 0b17362f12..d263c29d43 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 -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. +experimental: 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. This command is invoking the endpoint with OperationID: 'listStreamConnections'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamConnections diff --git a/docs/command/atlas-api-streams-listStreamInstances.txt b/docs/command/atlas-api-streams-listStreamInstances.txt index 4a4ab3d4b8..71511aee2a 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 -Returns all stream instances for the specified project. +experimental: Returns all stream instances for the specified project. This command is invoking the endpoint with OperationID: 'listStreamInstances'. For more information about flags, format of --file and examples, see: 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 0da291ca31..04f86243a4 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 -Returns all Stream Processors within the specified stream instance. +experimental: Returns all Stream Processors within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'listStreamProcessors'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamProcessors diff --git a/docs/command/atlas-api-streams-modifyStreamProcessor.txt b/docs/command/atlas-api-streams-modifyStreamProcessor.txt index c4e7a8e19f..9f37762611 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 -Modify one existing Stream Processor within the specified stream instance. +experimental: Modify one existing Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'modifyStreamProcessor'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/modifyStreamProcessor diff --git a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt index 83a5c8e68e..df9b1e6bd3 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 -Requests the rejection of an incoming VPC Peering connection. +experimental: Requests the rejection of an incoming VPC Peering connection. This command is invoking the endpoint with OperationID: 'rejectVpcPeeringConnection'. For more information about flags, format of --file and examples, see: 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 98c93ee278..09c9aa0f26 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 -Start a Stream Processor within the specified stream instance. +experimental: Start a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'startStreamProcessor'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startStreamProcessor diff --git a/docs/command/atlas-api-streams-stopStreamProcessor.txt b/docs/command/atlas-api-streams-stopStreamProcessor.txt index 1751acff0f..2524fc6ea7 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 -Stop a Stream Processor within the specified stream instance. +experimental: Stop a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'stopStreamProcessor'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/stopStreamProcessor diff --git a/docs/command/atlas-api-streams-updateStreamConnection.txt b/docs/command/atlas-api-streams-updateStreamConnection.txt index b21fced7e1..550296996b 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 -Update one connection for the specified stream instance in the specified project. +experimental: Update one connection for the specified stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'updateStreamConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamConnection diff --git a/docs/command/atlas-api-streams-updateStreamInstance.txt b/docs/command/atlas-api-streams-updateStreamInstance.txt index 7653f50194..f56f036a94 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 -Update one stream instance in the specified project. +experimental: Update one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'updateStreamInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamInstance diff --git a/docs/command/atlas-api-streams.txt b/docs/command/atlas-api-streams.txt index 30502315aa..bfb2de47cf 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 -Returns, adds, edits, and removes Streams Instances. +experimental: Returns, adds, edits, and removes Streams Instances. This resource requires your project ID. @@ -51,34 +51,34 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-streams-acceptVpcPeeringConnection` - Requests the acceptance of an incoming VPC Peering connection. -* :ref:`atlas-api-streams-createPrivateLinkConnection` - Creates one Private Link in the specified project. -* :ref:`atlas-api-streams-createStreamConnection` - Creates one connection for a stream instance in the specified project. -* :ref:`atlas-api-streams-createStreamInstance` - Creates one stream instance in the specified project. -* :ref:`atlas-api-streams-createStreamInstanceWithSampleConnections` - Creates one stream instance in the specified project with sample connections. -* :ref:`atlas-api-streams-createStreamProcessor` - Create one Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-deletePrivateLinkConnection` - Deletes one Private Link in the specified project. -* :ref:`atlas-api-streams-deleteStreamConnection` - Delete one connection of the specified stream instance. -* :ref:`atlas-api-streams-deleteStreamInstance` - Delete one stream instance in the specified project. -* :ref:`atlas-api-streams-deleteStreamProcessor` - Delete a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-deleteVpcPeeringConnection` - Deletes an incoming VPC Peering connection. -* :ref:`atlas-api-streams-downloadStreamTenantAuditLogs` - Downloads the audit logs for the specified Atlas Streams Processing instance. -* :ref:`atlas-api-streams-getAccountDetails` - Returns the Account ID, and the VPC ID for the group and region specified. -* :ref:`atlas-api-streams-getPrivateLinkConnection` - Returns the details of one Private Link connection within the project. -* :ref:`atlas-api-streams-getStreamConnection` - Returns the details of one stream connection within the specified stream instance. -* :ref:`atlas-api-streams-getStreamInstance` - Returns the details of one stream instance within the specified project. -* :ref:`atlas-api-streams-getStreamProcessor` - Get one Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-getVpcPeeringConnections` - Returns a list of incoming VPC Peering Connections. -* :ref:`atlas-api-streams-listPrivateLinkConnections` - Returns all Private Link connections for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. -* :ref:`atlas-api-streams-listStreamConnections` - 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. -* :ref:`atlas-api-streams-listStreamInstances` - Returns all stream instances for the specified project. -* :ref:`atlas-api-streams-listStreamProcessors` - Returns all Stream Processors within the specified stream instance. -* :ref:`atlas-api-streams-modifyStreamProcessor` - Modify one existing Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-rejectVpcPeeringConnection` - Requests the rejection of an incoming VPC Peering connection. -* :ref:`atlas-api-streams-startStreamProcessor` - Start a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-stopStreamProcessor` - Stop a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-updateStreamConnection` - Update one connection for the specified stream instance in the specified project. -* :ref:`atlas-api-streams-updateStreamInstance` - Update one stream instance in the specified project. +* :ref:`atlas-api-streams-acceptVpcPeeringConnection` - experimental: Requests the acceptance of an incoming VPC Peering connection. +* :ref:`atlas-api-streams-createPrivateLinkConnection` - experimental: Creates one Private Link in the specified project. +* :ref:`atlas-api-streams-createStreamConnection` - experimental: Creates one connection for a stream instance in the specified project. +* :ref:`atlas-api-streams-createStreamInstance` - experimental: Creates one stream instance in the specified project. +* :ref:`atlas-api-streams-createStreamInstanceWithSampleConnections` - experimental: Creates one stream instance in the specified project with sample connections. +* :ref:`atlas-api-streams-createStreamProcessor` - experimental: Create one Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-deletePrivateLinkConnection` - experimental: Deletes one Private Link in the specified project. +* :ref:`atlas-api-streams-deleteStreamConnection` - experimental: Delete one connection of the specified stream instance. +* :ref:`atlas-api-streams-deleteStreamInstance` - experimental: Delete one stream instance in the specified project. +* :ref:`atlas-api-streams-deleteStreamProcessor` - experimental: Delete a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-deleteVpcPeeringConnection` - experimental: Deletes an incoming VPC Peering connection. +* :ref:`atlas-api-streams-downloadStreamTenantAuditLogs` - experimental: Downloads the audit logs for the specified Atlas Streams Processing instance. +* :ref:`atlas-api-streams-getAccountDetails` - experimental: Returns the Account ID, and the VPC ID for the group and region specified. +* :ref:`atlas-api-streams-getPrivateLinkConnection` - experimental: Returns the details of one Private Link connection within the project. +* :ref:`atlas-api-streams-getStreamConnection` - experimental: Returns the details of one stream connection within the specified stream instance. +* :ref:`atlas-api-streams-getStreamInstance` - experimental: Returns the details of one stream instance within the specified project. +* :ref:`atlas-api-streams-getStreamProcessor` - experimental: Get one Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-getVpcPeeringConnections` - experimental: Returns a list of incoming VPC Peering Connections. +* :ref:`atlas-api-streams-listPrivateLinkConnections` - experimental: 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. +* :ref:`atlas-api-streams-listStreamConnections` - experimental: 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. +* :ref:`atlas-api-streams-listStreamInstances` - experimental: Returns all stream instances for the specified project. +* :ref:`atlas-api-streams-listStreamProcessors` - experimental: Returns all Stream Processors within the specified stream instance. +* :ref:`atlas-api-streams-modifyStreamProcessor` - experimental: Modify one existing Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-rejectVpcPeeringConnection` - experimental: Requests the rejection of an incoming VPC Peering connection. +* :ref:`atlas-api-streams-startStreamProcessor` - experimental: Start a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-stopStreamProcessor` - experimental: Stop a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-updateStreamConnection` - experimental: Update one connection for the specified stream instance in the specified project. +* :ref:`atlas-api-streams-updateStreamInstance` - experimental: 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 9a38f2b14c..547b0a7271 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 -Adds one team to the specified project. +experimental: Adds one team to the specified project. All members of the team share the same project access. MongoDB Cloud limits the number of users to a maximum of 100 teams per project and a maximum of 250 teams per organization. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'addAllTeamsToProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addAllTeamsToProject diff --git a/docs/command/atlas-api-teams-addTeamUser.txt b/docs/command/atlas-api-teams-addTeamUser.txt index 08218b1a75..74353b14ae 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 -Adds one or more MongoDB Cloud users from the specified organization to the specified team. +experimental: Adds one or more MongoDB Cloud users from the specified organization to the specified team. Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'addTeamUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addTeamUser diff --git a/docs/command/atlas-api-teams-createTeam.txt b/docs/command/atlas-api-teams-createTeam.txt index 57bd591f79..031707a9a1 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 -Creates one team in the specified organization. +experimental: Creates one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits the number of teams to a maximum of 250 teams per organization. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'createTeam'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/createTeam diff --git a/docs/command/atlas-api-teams-deleteTeam.txt b/docs/command/atlas-api-teams-deleteTeam.txt index 0179db64d3..a98263c340 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 -Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. +experimental: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'deleteTeam'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/deleteTeam diff --git a/docs/command/atlas-api-teams-getTeamById.txt b/docs/command/atlas-api-teams-getTeamById.txt index 2df6dc1046..740503ad3d 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 -Returns one team that you identified using its unique 24-hexadecimal digit ID. +experimental: Returns one team that you identified using its unique 24-hexadecimal digit ID. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'getTeamById'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamById diff --git a/docs/command/atlas-api-teams-getTeamByName.txt b/docs/command/atlas-api-teams-getTeamByName.txt index a04812ae89..6969559821 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 -Returns one team that you identified using its human-readable name. +experimental: Returns one team that you identified using its human-readable name. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'getTeamByName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamByName diff --git a/docs/command/atlas-api-teams-listOrganizationTeams.txt b/docs/command/atlas-api-teams-listOrganizationTeams.txt index 94ce3102da..7929adbde0 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 -Returns all teams that belong to the specified organization. +experimental: Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listOrganizationTeams'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listOrganizationTeams diff --git a/docs/command/atlas-api-teams-listProjectTeams.txt b/docs/command/atlas-api-teams-listProjectTeams.txt index 35b12bef21..1d5d7090d8 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 -Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. +experimental: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listProjectTeams'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listProjectTeams diff --git a/docs/command/atlas-api-teams-listTeamUsers.txt b/docs/command/atlas-api-teams-listTeamUsers.txt index 9dd71c2b82..a3f14b582c 100644 --- a/docs/command/atlas-api-teams-listTeamUsers.txt +++ b/docs/command/atlas-api-teams-listTeamUsers.txt @@ -12,7 +12,7 @@ atlas api teams listTeamUsers :depth: 1 :class: singlecol -Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. +experimental: Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listTeamUsers'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listTeamUsers diff --git a/docs/command/atlas-api-teams-removeProjectTeam.txt b/docs/command/atlas-api-teams-removeProjectTeam.txt index b2c1f8d231..5ca4252ce5 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 -Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. +experimental: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'removeProjectTeam'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeProjectTeam diff --git a/docs/command/atlas-api-teams-removeTeamUser.txt b/docs/command/atlas-api-teams-removeTeamUser.txt index 09477ea74f..dfbf2b0991 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 -Removes one MongoDB Cloud user from the specified team. +experimental: Removes one MongoDB Cloud user from the specified team. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'removeTeamUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeTeamUser diff --git a/docs/command/atlas-api-teams-renameTeam.txt b/docs/command/atlas-api-teams-renameTeam.txt index 4fe065f152..7b0f5051b0 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 -Renames one team in the specified organization. +experimental: Renames one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'renameTeam'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/renameTeam diff --git a/docs/command/atlas-api-teams-updateTeamRoles.txt b/docs/command/atlas-api-teams-updateTeamRoles.txt index 1fc883d6c9..a42c78fa63 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 -Updates the project roles assigned to the specified team. +experimental: Updates the project roles assigned to the specified team. You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateTeamRoles'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/updateTeamRoles diff --git a/docs/command/atlas-api-teams.txt b/docs/command/atlas-api-teams.txt index 702b86097b..ec05a80b2e 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 -Returns, adds, edits, or removes teams. +experimental: Returns, adds, edits, or removes teams. Options ------- @@ -49,19 +49,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-teams-addAllTeamsToProject` - Adds one team to the specified project. -* :ref:`atlas-api-teams-addTeamUser` - Adds one or more MongoDB Cloud users from the specified organization to the specified team. -* :ref:`atlas-api-teams-createTeam` - Creates one team in the specified organization. -* :ref:`atlas-api-teams-deleteTeam` - Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. -* :ref:`atlas-api-teams-getTeamById` - Returns one team that you identified using its unique 24-hexadecimal digit ID. -* :ref:`atlas-api-teams-getTeamByName` - Returns one team that you identified using its human-readable name. -* :ref:`atlas-api-teams-listOrganizationTeams` - Returns all teams that belong to the specified organization. -* :ref:`atlas-api-teams-listProjectTeams` - Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. -* :ref:`atlas-api-teams-listTeamUsers` - Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. -* :ref:`atlas-api-teams-removeProjectTeam` - Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. -* :ref:`atlas-api-teams-removeTeamUser` - Removes one MongoDB Cloud user from the specified team. -* :ref:`atlas-api-teams-renameTeam` - Renames one team in the specified organization. -* :ref:`atlas-api-teams-updateTeamRoles` - Updates the project roles assigned to the specified team. +* :ref:`atlas-api-teams-addAllTeamsToProject` - experimental: Adds one team to the specified project. +* :ref:`atlas-api-teams-addTeamUser` - experimental: Adds one or more MongoDB Cloud users from the specified organization to the specified team. +* :ref:`atlas-api-teams-createTeam` - experimental: Creates one team in the specified organization. +* :ref:`atlas-api-teams-deleteTeam` - experimental: 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` - experimental: Returns one team that you identified using its unique 24-hexadecimal digit ID. +* :ref:`atlas-api-teams-getTeamByName` - experimental: Returns one team that you identified using its human-readable name. +* :ref:`atlas-api-teams-listOrganizationTeams` - experimental: Returns all teams that belong to the specified organization. +* :ref:`atlas-api-teams-listProjectTeams` - experimental: 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-listTeamUsers` - experimental: Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. +* :ref:`atlas-api-teams-removeProjectTeam` - experimental: 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` - experimental: Removes one MongoDB Cloud user from the specified team. +* :ref:`atlas-api-teams-renameTeam` - experimental: Renames one team in the specified organization. +* :ref:`atlas-api-teams-updateTeamRoles` - experimental: Updates the project roles assigned to the specified team. .. toctree:: diff --git a/docs/command/atlas-api-test-versionedExample.txt b/docs/command/atlas-api-test-versionedExample.txt index f8d452acc3..869c9433be 100644 --- a/docs/command/atlas-api-test-versionedExample.txt +++ b/docs/command/atlas-api-test-versionedExample.txt @@ -12,7 +12,7 @@ atlas api test versionedExample :depth: 1 :class: singlecol -Returns some text dummy data for test purposes. +experimental: Returns some text dummy data for test purposes. This command is invoking the endpoint with OperationID: 'versionedExample'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Test/operation/versionedExample diff --git a/docs/command/atlas-api-test.txt b/docs/command/atlas-api-test.txt index 9c67ef05fd..77d95a090c 100644 --- a/docs/command/atlas-api-test.txt +++ b/docs/command/atlas-api-test.txt @@ -12,7 +12,7 @@ atlas api test :depth: 1 :class: singlecol -Atlas test endpoints. +experimental: Atlas test endpoints. Options ------- @@ -49,7 +49,7 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-test-versionedExample` - Returns some text dummy data for test purposes. +* :ref:`atlas-api-test-versionedExample` - experimental: Returns some text dummy data for test purposes. .. toctree:: diff --git a/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt index a6d2ecb9c4..edb6014435 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 -Adds the settings for configuring one third-party service integration. +experimental: Adds the settings for configuring one third-party service integration. These settings apply to all databases managed in the specified MongoDB Cloud project. Each project can have only one configuration per {INTEGRATION-TYPE}. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This command is invoking the endpoint with OperationID: 'createThirdPartyIntegration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/createThirdPartyIntegration diff --git a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt index f17e54a3c1..c28e7e38fb 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 -Removes the settings that permit configuring one third-party service integration. +experimental: Removes the settings that permit configuring one third-party service integration. These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured {INTEGRATION-TYPE} integrations. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This command is invoking the endpoint with OperationID: 'deleteThirdPartyIntegration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/deleteThirdPartyIntegration diff --git a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt index fcadc8835f..5caaa479a2 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 -Returns the settings for configuring integration with one third-party service. +experimental: Returns the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This command is invoking the endpoint with OperationID: 'getThirdPartyIntegration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/getThirdPartyIntegration diff --git a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt index e95fa01c99..eb3b5066ce 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 -Returns the settings that permit integrations with all configured third-party services. +experimental: Returns the settings that permit integrations with all configured third-party services. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This command is invoking the endpoint with OperationID: 'listThirdPartyIntegrations'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/listThirdPartyIntegrations diff --git a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt index 41ea988ba8..7c22135456 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 -Updates the settings for configuring integration with one third-party service. +experimental: Updates the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This command is invoking the endpoint with OperationID: 'updateThirdPartyIntegration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/updateThirdPartyIntegration diff --git a/docs/command/atlas-api-thirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations.txt index 9ce7b11e05..66c2b02969 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 -Returns, adds, edits, and removes third-party service integration configurations. +experimental: Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure. IMPORTANT: Each project can only have one configuration per integrationType. @@ -51,11 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-thirdPartyIntegrations-createThirdPartyIntegration` - Adds the settings for configuring one third-party service integration. -* :ref:`atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration` - Removes the settings that permit configuring one third-party service integration. -* :ref:`atlas-api-thirdPartyIntegrations-getThirdPartyIntegration` - Returns the settings for configuring integration with one third-party service. -* :ref:`atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations` - Returns the settings that permit integrations with all configured third-party services. -* :ref:`atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration` - Updates the settings for configuring integration with one third-party service. +* :ref:`atlas-api-thirdPartyIntegrations-createThirdPartyIntegration` - experimental: Adds the settings for configuring one third-party service integration. +* :ref:`atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration` - experimental: Removes the settings that permit configuring one third-party service integration. +* :ref:`atlas-api-thirdPartyIntegrations-getThirdPartyIntegration` - experimental: Returns the settings for configuring integration with one third-party service. +* :ref:`atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations` - experimental: Returns the settings that permit integrations with all configured third-party services. +* :ref:`atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration` - experimental: 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 3e2cbe17ad..912316dc9f 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 -Generates one X.509 certificate for the specified MongoDB user. +experimental: Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting API Key must have the Project Owner role. To get MongoDB Cloud to generate a managed certificate for a database user, set "x509Type" : "MANAGED" on the desired MongoDB Database User. If you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA. This command is invoking the endpoint with OperationID: 'createDatabaseUserCertificate'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/createDatabaseUserCertificate diff --git a/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt b/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt index c64d3976c5..46c7e3550e 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 -Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. +experimental: 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. This command is invoking the endpoint with OperationID: 'disableCustomerManagedX509'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/disableCustomerManagedX509 diff --git a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt b/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt index bca61aeb75..69d7472288 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 -Returns all unexpired X.509 certificates for the specified MongoDB user. +experimental: Returns all unexpired X.509 certificates for the specified MongoDB user. This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listDatabaseUserCertificates'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/listDatabaseUserCertificates diff --git a/docs/command/atlas-api-x509Authentication.txt b/docs/command/atlas-api-x509Authentication.txt index 4ca597d0be..ce35dbd8ca 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 -Returns, edits, and removes user-managed X.509 configurations. +experimental: 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 +51,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-x509Authentication-createDatabaseUserCertificate` - Generates one X.509 certificate for the specified MongoDB user. -* :ref:`atlas-api-x509Authentication-disableCustomerManagedX509` - Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. -* :ref:`atlas-api-x509Authentication-listDatabaseUserCertificates` - Returns all unexpired X.509 certificates for the specified MongoDB user. +* :ref:`atlas-api-x509Authentication-createDatabaseUserCertificate` - experimental: Generates one X.509 certificate for the specified MongoDB user. +* :ref:`atlas-api-x509Authentication-disableCustomerManagedX509` - experimental: 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` - experimental: 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 b0372a79fb..ceddfd5050 100644 --- a/docs/command/atlas-api.txt +++ b/docs/command/atlas-api.txt @@ -12,7 +12,7 @@ atlas api :depth: 1 :class: singlecol - +experimental: Interact directly with any Atlas Admin API endpoint through the Atlas CLI, streamlining script development. Options ------- @@ -49,58 +49,58 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-accessTracking` - Returns access logs for authentication attempts made to Atlas database deployments. -* :ref:`atlas-api-alertConfigurations` - Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. -* :ref:`atlas-api-alerts` - Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. -* :ref:`atlas-api-atlasSearch` - Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. -* :ref:`atlas-api-auditing` - Returns and edits database auditing settings for MongoDB Cloud projects. -* :ref:`atlas-api-awsClustersDns` - Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. -* :ref:`atlas-api-cloudBackups` - Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. -* :ref:`atlas-api-cloudMigrationService` - Manages the Cloud Migration Service. -* :ref:`atlas-api-cloudProviderAccess` - Returns, adds, authorizes, and removes AWS IAM roles in Atlas. -* :ref:`atlas-api-clusterOutageSimulation` - Returns, starts, or ends a cluster outage simulation. -* :ref:`atlas-api-clusters` - Returns, adds, edits, and removes database deployments. -* :ref:`atlas-api-collectionLevelMetrics` - Returns, adds, and edits pinned namespaces for the specified cluster or process. -* :ref:`atlas-api-customDatabaseRoles` - Returns, adds, edits, and removes custom database user privilege roles. -* :ref:`atlas-api-dataFederation` - Returns, adds, edits, and removes Federated Database Instances. -* :ref:`atlas-api-dataLakePipelines` - Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. -* :ref:`atlas-api-databaseUsers` - Returns, adds, edits, and removes database users. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement` - Returns and edits the Encryption at Rest using Customer Key Management configuration. -* :ref:`atlas-api-events` - Returns events. -* :ref:`atlas-api-federatedAuthentication` - Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. -* :ref:`atlas-api-flexClusters` - Returns, adds, edits, and removes flex clusters. -* :ref:`atlas-api-flexRestoreJobs` - Returns and adds restore jobs for flex database deployments. -* :ref:`atlas-api-flexSnapshots` - Returns and requests to download flex database deployment snapshots. -* :ref:`atlas-api-globalClusters` - Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. -* :ref:`atlas-api-invoices` - Returns invoices. -* :ref:`atlas-api-ldapConfiguration` - Returns, edits, verifies, and removes LDAP configurations. -* :ref:`atlas-api-legacyBackup` - Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. -* :ref:`atlas-api-maintenanceWindows` - Returns, edits, and removes maintenance windows. -* :ref:`atlas-api-mongoDbCloudUsers` - Returns, adds, and edits MongoDB Cloud users. -* :ref:`atlas-api-monitoringAndLogs` - Returns database deployment monitoring and logging data. -* :ref:`atlas-api-networkPeering` - Returns, adds, edits, and removes network peering containers and peering connections. -* :ref:`atlas-api-onlineArchive` - Returns, adds, edits, or removes an online archive. -* :ref:`atlas-api-openApi` - Returns information about the MongoDB Atlas Specification. -* :ref:`atlas-api-organizations` - Returns, adds, and edits organizational units in MongoDB Cloud. -* :ref:`atlas-api-performanceAdvisor` - Returns suggested indexes and slow query data for a database deployment. -* :ref:`atlas-api-privateEndpointServices` - Returns, adds, edits, and removes private endpoint services. -* :ref:`atlas-api-programmaticApiKeys` - Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. -* :ref:`atlas-api-projectIpAccessList` - Returns, adds, edits, and removes network access limits to database deployments in Atlas. -* :ref:`atlas-api-projects` - Returns, adds, and edits collections of clusters and users in MongoDB Cloud. -* :ref:`atlas-api-pushBasedLogExport` - You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. -* :ref:`atlas-api-resourcePolicies` - Configure and manage Atlas Resource Policies within your organization. -* :ref:`atlas-api-rollingIndex` - Creates one index to a database deployment in a rolling manner. -* :ref:`atlas-api-root` - Returns details that describe the MongoDB Cloud build and the access token that requests this resource. -* :ref:`atlas-api-serverlessInstances` - Returns, adds, edits, and removes serverless instances. -* :ref:`atlas-api-serverlessPrivateEndpoints` - Returns, adds, edits, and removes private endpoints for serverless instances. -* :ref:`atlas-api-serviceAccounts` - Endpoints for managing Service Accounts and secrets. -* :ref:`atlas-api-sharedTierRestoreJobs` - Returns and adds restore jobs for shared-tier database deployments. -* :ref:`atlas-api-sharedTierSnapshots` - Returns and requests to download shared-tier database deployment snapshots. -* :ref:`atlas-api-streams` - Returns, adds, edits, and removes Streams Instances. -* :ref:`atlas-api-teams` - Returns, adds, edits, or removes teams. -* :ref:`atlas-api-test` - Atlas test endpoints. -* :ref:`atlas-api-thirdPartyIntegrations` - Returns, adds, edits, and removes third-party service integration configurations. -* :ref:`atlas-api-x509Authentication` - Returns, edits, and removes user-managed X.509 configurations. +* :ref:`atlas-api-accessTracking` - experimental: Returns access logs for authentication attempts made to Atlas database deployments. +* :ref:`atlas-api-alertConfigurations` - experimental: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. +* :ref:`atlas-api-alerts` - experimental: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. +* :ref:`atlas-api-atlasSearch` - experimental: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. +* :ref:`atlas-api-auditing` - experimental: Returns and edits database auditing settings for MongoDB Cloud projects. +* :ref:`atlas-api-awsClustersDns` - experimental: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. +* :ref:`atlas-api-cloudBackups` - experimental: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. +* :ref:`atlas-api-cloudMigrationService` - experimental: Manages the Cloud Migration Service. +* :ref:`atlas-api-cloudProviderAccess` - experimental: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. +* :ref:`atlas-api-clusterOutageSimulation` - experimental: Returns, starts, or ends a cluster outage simulation. +* :ref:`atlas-api-clusters` - experimental: Returns, adds, edits, and removes database deployments. +* :ref:`atlas-api-collectionLevelMetrics` - experimental: Returns, adds, and edits pinned namespaces for the specified cluster or process. +* :ref:`atlas-api-customDatabaseRoles` - experimental: Returns, adds, edits, and removes custom database user privilege roles. +* :ref:`atlas-api-dataFederation` - experimental: Returns, adds, edits, and removes Federated Database Instances. +* :ref:`atlas-api-dataLakePipelines` - experimental: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. +* :ref:`atlas-api-databaseUsers` - experimental: Returns, adds, edits, and removes database users. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement` - experimental: Returns and edits the Encryption at Rest using Customer Key Management configuration. +* :ref:`atlas-api-events` - experimental: Returns events. +* :ref:`atlas-api-federatedAuthentication` - experimental: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. +* :ref:`atlas-api-flexClusters` - experimental: Returns, adds, edits, and removes flex clusters. +* :ref:`atlas-api-flexRestoreJobs` - experimental: Returns and adds restore jobs for flex database deployments. +* :ref:`atlas-api-flexSnapshots` - experimental: Returns and requests to download flex database deployment snapshots. +* :ref:`atlas-api-globalClusters` - experimental: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. +* :ref:`atlas-api-invoices` - experimental: Returns invoices. +* :ref:`atlas-api-ldapConfiguration` - experimental: Returns, edits, verifies, and removes LDAP configurations. +* :ref:`atlas-api-legacyBackup` - experimental: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. +* :ref:`atlas-api-maintenanceWindows` - experimental: Returns, edits, and removes maintenance windows. +* :ref:`atlas-api-mongoDbCloudUsers` - experimental: Returns, adds, and edits MongoDB Cloud users. +* :ref:`atlas-api-monitoringAndLogs` - experimental: Returns database deployment monitoring and logging data. +* :ref:`atlas-api-networkPeering` - experimental: Returns, adds, edits, and removes network peering containers and peering connections. +* :ref:`atlas-api-onlineArchive` - experimental: Returns, adds, edits, or removes an online archive. +* :ref:`atlas-api-openApi` - experimental: Returns information about the MongoDB Atlas Specification. +* :ref:`atlas-api-organizations` - experimental: Returns, adds, and edits organizational units in MongoDB Cloud. +* :ref:`atlas-api-performanceAdvisor` - experimental: Returns suggested indexes and slow query data for a database deployment. +* :ref:`atlas-api-privateEndpointServices` - experimental: Returns, adds, edits, and removes private endpoint services. +* :ref:`atlas-api-programmaticApiKeys` - experimental: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. +* :ref:`atlas-api-projectIpAccessList` - experimental: Returns, adds, edits, and removes network access limits to database deployments in Atlas. +* :ref:`atlas-api-projects` - experimental: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. +* :ref:`atlas-api-pushBasedLogExport` - experimental: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. +* :ref:`atlas-api-resourcePolicies` - experimental: Configure and manage Atlas Resource Policies within your organization. +* :ref:`atlas-api-rollingIndex` - experimental: Creates one index to a database deployment in a rolling manner. +* :ref:`atlas-api-root` - experimental: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. +* :ref:`atlas-api-serverlessInstances` - experimental: Returns, adds, edits, and removes serverless instances. +* :ref:`atlas-api-serverlessPrivateEndpoints` - experimental: Returns, adds, edits, and removes private endpoints for serverless instances. +* :ref:`atlas-api-serviceAccounts` - experimental: Endpoints for managing Service Accounts and secrets. +* :ref:`atlas-api-sharedTierRestoreJobs` - experimental: Returns and adds restore jobs for shared-tier database deployments. +* :ref:`atlas-api-sharedTierSnapshots` - experimental: Returns and requests to download shared-tier database deployment snapshots. +* :ref:`atlas-api-streams` - experimental: Returns, adds, edits, and removes Streams Instances. +* :ref:`atlas-api-teams` - experimental: Returns, adds, edits, or removes teams. +* :ref:`atlas-api-test` - experimental: Atlas test endpoints. +* :ref:`atlas-api-thirdPartyIntegrations` - experimental: Returns, adds, edits, and removes third-party service integration configurations. +* :ref:`atlas-api-x509Authentication` - experimental: Returns, edits, and removes user-managed X.509 configurations. .. toctree:: diff --git a/docs/command/atlas.txt b/docs/command/atlas.txt index cca8aafdfe..2331b90ce4 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` - +* :ref:`atlas-api` - experimental: Interact directly with any Atlas Admin API endpoint through the Atlas CLI, streamlining script development. * :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 eb8fd5d5dd..4cb22be5c0 100644 --- a/internal/cli/api/api.go +++ b/internal/cli/api/api.go @@ -24,6 +24,7 @@ import ( "github.com/iancoleman/strcase" "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/api" + "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/cli" "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/flag" "github.com/mongodb/mongodb-atlas-cli/atlascli/internal/log" "github.com/spf13/cobra" @@ -62,9 +63,14 @@ func Builder() *cobra.Command { } func createRootAPICommand() *cobra.Command { - return &cobra.Command{ - Use: "api", + rootCmd := &cobra.Command{ + Use: "api", + Short: "Interact directly with any Atlas Admin API endpoint through the Atlas CLI, streamlining script development.", } + + rootCmd.SetHelpTemplate(cli.ExperimentalHelpTemplate) + + return rootCmd } func createAPICommandGroupToCobraCommand(group api.Group) *cobra.Command { diff --git a/internal/cli/help_templates.go b/internal/cli/help_templates.go new file mode 100644 index 0000000000..c30422336f --- /dev/null +++ b/internal/cli/help_templates.go @@ -0,0 +1,11 @@ +package cli + +const ( + // Help template + // 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 = "experimental: " + HelpTemplate +) diff --git a/internal/cli/root/builder.go b/internal/cli/root/builder.go index 455fe04200..94c11b007b 100644 --- a/internal/cli/root/builder.go +++ b/internal/cli/root/builder.go @@ -99,11 +99,6 @@ const ( // OptionalAuth command can work with or without authentication, // and if access token is found, try to refresh it. OptionalAuth AuthRequirements = 2 - // Help template - // 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}}` ) func handleSignal() { @@ -203,7 +198,7 @@ Use the --help flag with any command for more info on that command.`, }, } rootCmd.SetVersionTemplate(formattedVersion()) - rootCmd.SetHelpTemplate(HelpTemplate) + rootCmd.SetHelpTemplate(cli.HelpTemplate) // hidden shortcuts loginCmd := auth.LoginBuilder() diff --git a/tools/docs/main.go b/tools/docs/main.go index 43dbf523a8..829b337f87 100644 --- a/tools/docs/main.go +++ b/tools/docs/main.go @@ -32,6 +32,29 @@ func setDisableAutoGenTag(cmd *cobra.Command) { } } +func addExperimenalToAPICommands(cmd *cobra.Command) { + var apiCommand *cobra.Command + for _, subCommand := range cmd.Commands() { + if subCommand.Use == "api" { + apiCommand = subCommand + } + } + + if apiCommand == nil { + panic("api command not found!") + } + + markExperimentalRecursively(apiCommand) +} + +func markExperimentalRecursively(cmd *cobra.Command) { + cmd.Short = "experimental: " + cmd.Short + + for _, subCommand := range cmd.Commands() { + markExperimentalRecursively(subCommand) + } +} + func main() { if err := os.RemoveAll("./docs/command"); err != nil { log.Fatal(err) @@ -53,6 +76,7 @@ func main() { atlasBuilder.InitDefaultCompletionCmd() setDisableAutoGenTag(atlasBuilder) + addExperimenalToAPICommands(atlasBuilder) if err := cobra2snooty.GenTreeDocs(atlasBuilder, "./docs/command"); err != nil { log.Fatal(err) From 48f42977ae828688905ac62a7946df8c02cccd5b Mon Sep 17 00:00:00 2001 From: Jeroen Vervaeke Date: Wed, 29 Jan 2025 15:51:49 +0000 Subject: [PATCH 2/4] Ran 'make addcopy' --- internal/cli/help_templates.go | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/internal/cli/help_templates.go b/internal/cli/help_templates.go index c30422336f..c9aa1600d2 100644 --- a/internal/cli/help_templates.go +++ b/internal/cli/help_templates.go @@ -1,3 +1,17 @@ +// Copyright 2025 MongoDB Inc +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + package cli const ( From 89afed86b6b1ee8038e3c6e40b70bf89382716cf Mon Sep 17 00:00:00 2001 From: Jeroen Vervaeke Date: Thu, 30 Jan 2025 16:13:45 +0000 Subject: [PATCH 3/4] Add a link to the 'atlas api' docs, which describes experimental --- ...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 +- .../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 +- ...sters-upgradeSharedClusterToServerless.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 +- ...ngoDbCloudUsers-removeOrganizationRole.txt | 2 +- ...pi-mongoDbCloudUsers-removeProjectRole.txt | 2 +- ...i-mongoDbCloudUsers-removeUserFromTeam.txt | 2 +- ...ngoDbCloudUsers-updateOrganizationUser.txt | 2 +- docs/command/atlas-api-mongoDbCloudUsers.txt | 30 ++--- ...-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 +-- .../atlas-api-openApi-getApiVersions.txt | 2 +- .../atlas-api-openApi-getOpenApiInfo.txt | 2 +- docs/command/atlas-api-openApi.txt | 6 +- ...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 +- ...pi-organizations-listOrganizationUsers.txt | 2 +- ...as-api-organizations-listOrganizations.txt | 2 +- ...i-organizations-removeOrganizationUser.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 | 36 +++--- ...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-listProjectUsers.txt | 2 +- .../atlas-api-projects-listProjects.txt | 2 +- ...pi-projects-migrateProjectToAnotherOrg.txt | 2 +- .../atlas-api-projects-removeProjectUser.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 | 52 ++++----- ...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 +- ...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 +- .../atlas-api-streams-stopStreamProcessor.txt | 2 +- ...las-api-streams-updateStreamConnection.txt | 2 +- ...atlas-api-streams-updateStreamInstance.txt | 2 +- docs/command/atlas-api-streams.txt | 58 +++++----- .../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 +- .../command/atlas-api-teams-listTeamUsers.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 | 28 ++--- .../atlas-api-test-versionedExample.txt | 2 +- docs/command/atlas-api-test.txt | 4 +- ...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 | 106 +++++++++--------- docs/command/atlas.txt | 2 +- tools/docs/main.go | 2 +- 508 files changed, 1013 insertions(+), 1013 deletions(-) diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt index ce0c22e104..e53aaeba19 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 -experimental: Returns the access logs of one cluster identified by the cluster's name. +`experimental `: Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. This command is invoking the endpoint with OperationID: 'listAccessLogsByClusterName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt index 59973f3adc..a9807476c5 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 -experimental: Returns the access logs of one cluster identified by the cluster's hostname. +`experimental `: Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. This command is invoking the endpoint with OperationID: 'listAccessLogsByHostname'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname diff --git a/docs/command/atlas-api-accessTracking.txt b/docs/command/atlas-api-accessTracking.txt index 7ee37daf98..41d9ef1dba 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 -experimental: Returns access logs for authentication attempts made to Atlas database deployments. +`experimental `: 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 +51,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - experimental: Returns the access logs of one cluster identified by the cluster's name. -* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - experimental: Returns the access logs of one cluster identified by the cluster's hostname. +* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - `experimental `: Returns the access logs of one cluster identified by the cluster's name. +* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - `experimental `: 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 1654eb37fd..66eb019537 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 -experimental: Creates one alert configuration for the specified project. +`experimental `: Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'createAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createAlertConfiguration diff --git a/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt index 9c9b1f53c8..dcf8f58f73 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 -experimental: Removes one alert configuration from the specified project. +`experimental `: Removes one alert configuration from the specified project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'deleteAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/deleteAlertConfiguration diff --git a/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt index fdd1caf1bc..0fe11e3203 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 -experimental: Returns the specified alert configuration from the specified project. +`experimental `: Returns the specified alert configuration from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'getAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getAlertConfiguration diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt index 0b156bc1bc..d4170b9c69 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 -experimental: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'listAlertConfigurationMatchersFieldNames'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationMatchersFieldNames diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt index 005b435067..d0206996ae 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 -experimental: Returns all alert configurations for one project. +`experimental `: Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlertConfigurations'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt index 7a59fc0bde..22b66b79ef 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 -experimental: Returns all alert configurations set for the specified alert. +`experimental `: Returns all alert configurations set for the specified alert. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlertConfigurationsByAlertId'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationsByAlertId diff --git a/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt index e9cb921f36..2f3345a1c7 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 -experimental: Enables or disables the specified alert configuration in the specified project. +`experimental `: Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. NOTE: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see Update One Alert Configuration. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'toggleAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration diff --git a/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt index 2f2ed3cdbc..bcf105d83f 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 -experimental: Updates one alert configuration in the specified project. +`experimental `: Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. NOTE: To enable or disable the alert configuration, see Toggle One State of One Alert Configuration in One Project. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'updateAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateAlertConfiguration diff --git a/docs/command/atlas-api-alertConfigurations.txt b/docs/command/atlas-api-alertConfigurations.txt index 3bec951ea3..315f6704f2 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 -experimental: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. +`experimental `: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change. @@ -51,14 +51,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - experimental: Creates one alert configuration for the specified project. -* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - experimental: Removes one alert configuration from the specified project. -* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - experimental: Returns the specified alert configuration from the specified project. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - experimental: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - experimental: Returns all alert configurations for one project. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - experimental: Returns all alert configurations set for the specified alert. -* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - experimental: Enables or disables the specified alert configuration in the specified project. -* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - experimental: Updates one alert configuration in the specified project. +* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - `experimental `: Creates one alert configuration for the specified project. +* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - `experimental `: Removes one alert configuration from the specified project. +* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - `experimental `: Returns the specified alert configuration from the specified project. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - `experimental `: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - `experimental `: Returns all alert configurations for one project. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - `experimental `: Returns all alert configurations set for the specified alert. +* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - `experimental `: Enables or disables the specified alert configuration in the specified project. +* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - `experimental `: 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 8ade35df56..1cd30f3b8c 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 -experimental: Confirms receipt of one existing alert. +`experimental `: Confirms receipt of one existing alert. This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'acknowledgeAlert'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeAlert diff --git a/docs/command/atlas-api-alerts-getAlert.txt b/docs/command/atlas-api-alerts-getAlert.txt index 9f4c3b8cc6..3cb47463cf 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 -experimental: Returns one alert. +`experimental `: Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'getAlert'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getAlert diff --git a/docs/command/atlas-api-alerts-listAlerts.txt b/docs/command/atlas-api-alerts-listAlerts.txt index 75e19dfa26..101d3b4b8d 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 -experimental: Returns all alerts. +`experimental `: Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlerts'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts diff --git a/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt b/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt index d32b8061de..6aa5aef04c 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 -experimental: Returns all open alerts that the specified alert configuration triggers. +`experimental `: Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlertsByAlertConfigurationId'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlertsByAlertConfigurationId diff --git a/docs/command/atlas-api-alerts.txt b/docs/command/atlas-api-alerts.txt index 6c94d1f104..108e2a02eb 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 -experimental: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. +`experimental `: 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 +51,10 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alerts-acknowledgeAlert` - experimental: Confirms receipt of one existing alert. -* :ref:`atlas-api-alerts-getAlert` - experimental: Returns one alert. -* :ref:`atlas-api-alerts-listAlerts` - experimental: Returns all alerts. -* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - experimental: Returns all open alerts that the specified alert configuration triggers. +* :ref:`atlas-api-alerts-acknowledgeAlert` - `experimental `: Confirms receipt of one existing alert. +* :ref:`atlas-api-alerts-getAlert` - `experimental `: Returns one alert. +* :ref:`atlas-api-alerts-listAlerts` - `experimental `: Returns all alerts. +* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - `experimental `: 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 ecc8c20f1d..c78d39377d 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 -experimental: Creates Search Nodes for the specified cluster. +`experimental `: Creates Search Nodes for the specified cluster. This command is invoking the endpoint with OperationID: 'createAtlasSearchDeployment'. For more information about flags, format of --file and examples, see: 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 a09202af0a..a7a1ca4a8a 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 -experimental: Creates one Atlas Search index on the specified collection. +`experimental `: Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'createAtlasSearchIndex'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndex diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt index 54ac8663a1..092ef4c475 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 -experimental: Creates one Atlas Search index on the specified collection. +`experimental `: Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'createAtlasSearchIndexDeprecated'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndexDeprecated diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt index 9b1e959425..43c1998dae 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 -experimental: Deletes the Search Nodes for the specified cluster. +`experimental `: Deletes the Search Nodes for the specified cluster. This command is invoking the endpoint with OperationID: 'deleteAtlasSearchDeployment'. For more information about flags, format of --file and examples, see: 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 e1f55e8488..71aa7402c8 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 -experimental: Removes one Atlas Search index that you identified with its unique ID. +`experimental `: Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent. This command is invoking the endpoint with OperationID: 'deleteAtlasSearchIndex'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndex diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt index 3888f4fc6f..ce9646df5e 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 -experimental: Removes one Atlas Search index that you identified with its database, collection, and name. +`experimental `: Removes one Atlas Search index that you identified with its database, collection, and name. To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent. This command is invoking the endpoint with OperationID: 'deleteAtlasSearchIndexByName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexByName diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt index 63519cd89c..dc8fd8242f 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 -experimental: Removes one Atlas Search index that you identified with its unique ID. +`experimental `: Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'deleteAtlasSearchIndexDeprecated'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexDeprecated diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt index 3dd944b85a..a92b007698 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 -experimental: Return the Search Nodes for the specified cluster. +`experimental `: Return the Search Nodes for the specified cluster. This command is invoking the endpoint with OperationID: 'getAtlasSearchDeployment'. For more information about flags, format of --file and examples, see: 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 2956bbb90d..2d373a595e 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 -experimental: Returns one Atlas Search index in the specified project. +`experimental `: Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'getAtlasSearchIndex'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndex diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt index f1d0e1ed68..a5e4862948 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 -experimental: Returns one Atlas Search index in the specified project. +`experimental `: Returns one Atlas Search index in the specified project. You identify this index using its database, collection and name. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'getAtlasSearchIndexByName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexByName diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt index 848379d462..8e3e047931 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 -experimental: Returns one Atlas Search index in the specified project. +`experimental `: Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'getAtlasSearchIndexDeprecated'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexDeprecated diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt index 6be1c4ee31..02015cb811 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 -experimental: Returns all Atlas Search indexes on the specified collection. +`experimental `: Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'listAtlasSearchIndexes'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexes diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt index 1d33b8c76a..e66817faf4 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 -experimental: Returns all Atlas Search indexes on the specified cluster. +`experimental `: Returns all Atlas Search indexes on the specified cluster. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'listAtlasSearchIndexesCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesCluster diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt index 1ac29d0520..ea566c2bc1 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 -experimental: Returns all Atlas Search indexes on the specified collection. +`experimental `: Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'listAtlasSearchIndexesDeprecated'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesDeprecated diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt index 0cea64c336..c26c1db20c 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 -experimental: Updates the Search Nodes for the specified cluster. +`experimental `: Updates the Search Nodes for the specified cluster. This command is invoking the endpoint with OperationID: 'updateAtlasSearchDeployment'. For more information about flags, format of --file and examples, see: 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 f172e656df..6ce0efff30 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 -experimental: Updates one Atlas Search index that you identified with its unique ID. +`experimental `: Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'updateAtlasSearchIndex'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndex diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt index ab0b4c9be1..464e95b189 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 -experimental: Updates one Atlas Search index that you identified with its database, collection name, and index name. +`experimental `: Updates one Atlas Search index that you identified with its database, collection name, and index name. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'updateAtlasSearchIndexByName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexByName diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt index 6d15c117bb..36ffaa6c0a 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 -experimental: Updates one Atlas Search index that you identified with its unique ID. +`experimental `: Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'updateAtlasSearchIndexDeprecated'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexDeprecated diff --git a/docs/command/atlas-api-atlasSearch.txt b/docs/command/atlas-api-atlasSearch.txt index cfa0a04758..c1832cbbc2 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 -experimental: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. +`experimental `: 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 +51,24 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-atlasSearch-createAtlasSearchDeployment` - experimental: Creates Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-createAtlasSearchIndex` - experimental: Creates one Atlas Search index on the specified collection. -* :ref:`atlas-api-atlasSearch-createAtlasSearchIndexDeprecated` - experimental: Creates one Atlas Search index on the specified collection. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchDeployment` - experimental: Deletes the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndex` - experimental: Removes one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexByName` - experimental: Removes one Atlas Search index that you identified with its database, collection, and name. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated` - experimental: Removes one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-getAtlasSearchDeployment` - experimental: Return the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndex` - experimental: Returns one Atlas Search index in the specified project. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexByName` - experimental: Returns one Atlas Search index in the specified project. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexDeprecated` - experimental: Returns one Atlas Search index in the specified project. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexes` - experimental: Returns all Atlas Search indexes on the specified collection. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesCluster` - experimental: Returns all Atlas Search indexes on the specified cluster. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated` - experimental: Returns all Atlas Search indexes on the specified collection. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchDeployment` - experimental: Updates the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndex` - experimental: Updates one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexByName` - experimental: Updates one Atlas Search index that you identified with its database, collection name, and index name. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated` - experimental: Updates one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-createAtlasSearchDeployment` - `experimental `: Creates Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-createAtlasSearchIndex` - `experimental `: Creates one Atlas Search index on the specified collection. +* :ref:`atlas-api-atlasSearch-createAtlasSearchIndexDeprecated` - `experimental `: Creates one Atlas Search index on the specified collection. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchDeployment` - `experimental `: Deletes the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndex` - `experimental `: Removes one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexByName` - `experimental `: Removes one Atlas Search index that you identified with its database, collection, and name. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated` - `experimental `: Removes one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-getAtlasSearchDeployment` - `experimental `: Return the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndex` - `experimental `: Returns one Atlas Search index in the specified project. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexByName` - `experimental `: Returns one Atlas Search index in the specified project. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexDeprecated` - `experimental `: Returns one Atlas Search index in the specified project. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexes` - `experimental `: Returns all Atlas Search indexes on the specified collection. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesCluster` - `experimental `: Returns all Atlas Search indexes on the specified cluster. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated` - `experimental `: Returns all Atlas Search indexes on the specified collection. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchDeployment` - `experimental `: Updates the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndex` - `experimental `: Updates one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexByName` - `experimental `: Updates one Atlas Search index that you identified with its database, collection name, and index name. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated` - `experimental `: 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 254e47a1ad..95f9d1a8a4 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 -experimental: Returns the auditing configuration for the specified project. +`experimental `: Returns the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. This command is invoking the endpoint with OperationID: 'getAuditingConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/getAuditingConfiguration diff --git a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt b/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt index 46abfd26bd..8ec25dc127 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 -experimental: Updates the auditing configuration for the specified project. +`experimental `: Updates the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. This command is invoking the endpoint with OperationID: 'updateAuditingConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/updateAuditingConfiguration diff --git a/docs/command/atlas-api-auditing.txt b/docs/command/atlas-api-auditing.txt index 5c199c81bf..96ee155750 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 -experimental: Returns and edits database auditing settings for MongoDB Cloud projects. +`experimental `: Returns and edits database auditing settings for MongoDB Cloud projects. Options ------- @@ -49,8 +49,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-auditing-getAuditingConfiguration` - experimental: Returns the auditing configuration for the specified project. -* :ref:`atlas-api-auditing-updateAuditingConfiguration` - experimental: Updates the auditing configuration for the specified project. +* :ref:`atlas-api-auditing-getAuditingConfiguration` - `experimental `: Returns the auditing configuration for the specified project. +* :ref:`atlas-api-auditing-updateAuditingConfiguration` - `experimental `: 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 60baf871f5..21e93d645f 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 -experimental: Returns the custom DNS configuration for AWS clusters in the specified project. +`experimental `: Returns the custom DNS configuration for AWS clusters in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getAwsCustomDns'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/getAwsCustomDns diff --git a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt index 1eae68cad9..684983de3e 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 -experimental: Enables or disables the custom DNS configuration for AWS clusters in the specified project. +`experimental `: Enables or disables the custom DNS configuration for AWS clusters in the specified project. Enable custom DNS if you use AWS VPC peering and use your own DNS servers. To use this resource, the requesting API Key must have the Project Atlas Admin role. This command is invoking the endpoint with OperationID: 'toggleAwsCustomDns'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/toggleAwsCustomDns diff --git a/docs/command/atlas-api-awsClustersDns.txt b/docs/command/atlas-api-awsClustersDns.txt index fc4a45f5ba..682309b4b9 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 -experimental: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. +`experimental `: 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 +51,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-awsClustersDns-getAwsCustomDns` - experimental: Returns the custom DNS configuration for AWS clusters in the specified project. -* :ref:`atlas-api-awsClustersDns-toggleAwsCustomDns` - experimental: Enables or disables the custom DNS configuration for AWS clusters in the specified project. +* :ref:`atlas-api-awsClustersDns-getAwsCustomDns` - `experimental `: Returns the custom DNS configuration for AWS clusters in the specified project. +* :ref:`atlas-api-awsClustersDns-toggleAwsCustomDns` - `experimental `: 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 07cca2bea3..3aa5fe0b80 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 -experimental: Cancels one cloud backup restore job of one cluster from the specified project. +`experimental `: Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'cancelBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelBackupRestoreJob diff --git a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt index 2e5f9318f6..c948a9bd79 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 -experimental: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. +`experimental `: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role. This command is invoking the endpoint with OperationID: 'createBackupExportJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupExportJob diff --git a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt index cdeb18172f..3f1a59afbe 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 -experimental: Restores one snapshot of one cluster from the specified project. +`experimental `: Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupRestoreJob diff --git a/docs/command/atlas-api-cloudBackups-createExportBucket.txt b/docs/command/atlas-api-cloudBackups-createExportBucket.txt index 98f883fb91..b3863cf06f 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 -experimental: Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. +`experimental `: Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createExportBucket'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createExportBucket diff --git a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt index 0d5aafd3b5..59a96ee9dd 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 -experimental: Restores one snapshot of one serverless instance from the specified project. +`experimental `: Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createServerlessBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createServerlessBackupRestoreJob diff --git a/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt b/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt index 81664be7e7..4546e09369 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 -experimental: Removes all cloud backup schedules for the specified cluster. +`experimental `: Removes all cloud backup schedules for the specified cluster. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Atlas Admin role. This command is invoking the endpoint with OperationID: 'deleteAllBackupSchedules'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteAllBackupSchedules diff --git a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt index 018cb766c2..978bfda40b 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 -experimental: Deletes an Export Bucket. +`experimental `: Deletes an Export Bucket. Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteExportBucket'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteExportBucket diff --git a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt index 41cacd83f2..72a1f14086 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 -experimental: Removes the specified snapshot. +`experimental `: Removes the specified snapshot. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteReplicaSetBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteReplicaSetBackup diff --git a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt index 93ed74a9b4..3d67df6d0c 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 -experimental: Removes one snapshot of one sharded cluster from the specified project. +`experimental `: Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteShardedClusterBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteShardedClusterBackup diff --git a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt index 08af58e53f..1aaff5d3be 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 -experimental: Disables the Backup Compliance Policy settings with the specified project. +`experimental `: 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 API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'disableDataProtectionSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/disableDataProtectionSettings diff --git a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt index 71da56442f..0c9b7c617d 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 -experimental: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. +`experimental `: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. This command is invoking the endpoint with OperationID: 'getBackupExportJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupExportJob diff --git a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt index 5e2088e30e..0bedb0b021 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 -experimental: Returns one cloud backup restore job for one cluster from the specified project. +`experimental `: Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupRestoreJob diff --git a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt index 1e26f8cbb5..2366c90636 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 -experimental: Returns the cloud backup schedule for the specified cluster within the specified project. +`experimental `: Returns the cloud backup schedule for the specified cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getBackupSchedule'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupSchedule diff --git a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt index 1cc2a01419..e01a9e4f8b 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 -experimental: Returns the Backup Compliance Policy settings with the specified project. +`experimental `: Returns the Backup Compliance Policy settings with the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getDataProtectionSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getDataProtectionSettings diff --git a/docs/command/atlas-api-cloudBackups-getExportBucket.txt b/docs/command/atlas-api-cloudBackups-getExportBucket.txt index abfcbb12a7..8d1edd4ed1 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 -experimental: Returns one Export Bucket associated with the specified Project. +`experimental `: Returns one Export Bucket associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getExportBucket'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getExportBucket diff --git a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt index 26e79db745..88deeb775d 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 -experimental: Returns one snapshot from the specified cluster. +`experimental `: Returns one snapshot from the specified cluster. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getReplicaSetBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getReplicaSetBackup diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt index d1be2eaec5..746d113ca5 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 -experimental: Returns one snapshot of one serverless instance from the specified project. +`experimental `: Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getServerlessBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackup diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt index 45ebbe06f6..3f7f351700 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 -experimental: Returns one restore job for one serverless instance from the specified project. +`experimental `: Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getServerlessBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackupRestoreJob diff --git a/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt index 6f1fea4976..024d3d5453 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 -experimental: Returns one snapshot of one sharded cluster from the specified project. +`experimental `: Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getShardedClusterBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getShardedClusterBackup diff --git a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt index 74c7606918..f72c6d1aac 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 -experimental: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. +`experimental `: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. This command is invoking the endpoint with OperationID: 'listBackupExportJobs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupExportJobs diff --git a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt index 5678ada950..841e7f6cf1 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 -experimental: Returns all cloud backup restore jobs for one cluster from the specified project. +`experimental `: Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'listBackupRestoreJobs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupRestoreJobs diff --git a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt index 7c4a448d93..de9aee6c8c 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 -experimental: Returns all Export Buckets associated with the specified Project. +`experimental `: Returns all Export Buckets associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listExportBuckets'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listExportBuckets diff --git a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt b/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt index 80f2c22d8b..82e987577a 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 -experimental: Returns all snapshots of one cluster from the specified project. +`experimental `: Returns all snapshots of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listReplicaSetBackups'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listReplicaSetBackups diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt index 766c3e234f..147798dc35 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 -experimental: Returns all restore jobs for one serverless instance from the specified project. +`experimental `: Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'listServerlessBackupRestoreJobs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackupRestoreJobs diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt index b6eaffa868..4d05c2e91f 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 -experimental: Returns all snapshots of one serverless instance from the specified project. +`experimental `: Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listServerlessBackups'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackups diff --git a/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt b/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt index 4d387b2e23..debf66011f 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 -experimental: Returns all snapshots of one sharded cluster from the specified project. +`experimental `: Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listShardedClusterBackups'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listShardedClusterBackups diff --git a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt b/docs/command/atlas-api-cloudBackups-takeSnapshot.txt index 3d2c32d045..f33589afb3 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 -experimental: Takes one on-demand snapshot for the specified cluster. +`experimental `: Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'takeSnapshot'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/takeSnapshot diff --git a/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt index f6a8c41684..a2b34d842f 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 -experimental: Updates the cloud backup schedule for one cluster within the specified project. +`experimental `: Updates the cloud backup schedule for one cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateBackupSchedule'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateBackupSchedule diff --git a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt index 59d6d3b88c..578461e383 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 -experimental: Updates the Backup Compliance Policy settings for the specified project. +`experimental `: Updates the Backup Compliance Policy settings for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateDataProtectionSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateDataProtectionSettings diff --git a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt b/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt index 8c6f8dcbac..2120bb7f97 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 -experimental: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +`experimental `: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. This command is invoking the endpoint with OperationID: 'updateSnapshotRetention'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateSnapshotRetention diff --git a/docs/command/atlas-api-cloudBackups.txt b/docs/command/atlas-api-cloudBackups.txt index 8c592543c0..42643d4dbd 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 -experimental: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. +`experimental `: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups. @@ -51,36 +51,36 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudBackups-cancelBackupRestoreJob` - experimental: Cancels one cloud backup restore job of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-createBackupExportJob` - experimental: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. -* :ref:`atlas-api-cloudBackups-createBackupRestoreJob` - experimental: Restores one snapshot of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-createExportBucket` - experimental: Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. -* :ref:`atlas-api-cloudBackups-createServerlessBackupRestoreJob` - experimental: Restores one snapshot of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-deleteAllBackupSchedules` - experimental: Removes all cloud backup schedules for the specified cluster. -* :ref:`atlas-api-cloudBackups-deleteExportBucket` - experimental: Deletes an Export Bucket. -* :ref:`atlas-api-cloudBackups-deleteReplicaSetBackup` - experimental: Removes the specified snapshot. -* :ref:`atlas-api-cloudBackups-deleteShardedClusterBackup` - experimental: Removes one snapshot of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-disableDataProtectionSettings` - experimental: Disables the Backup Compliance Policy settings with the specified project. -* :ref:`atlas-api-cloudBackups-getBackupExportJob` - experimental: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. -* :ref:`atlas-api-cloudBackups-getBackupRestoreJob` - experimental: Returns one cloud backup restore job for one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-getBackupSchedule` - experimental: Returns the cloud backup schedule for the specified cluster within the specified project. -* :ref:`atlas-api-cloudBackups-getDataProtectionSettings` - experimental: Returns the Backup Compliance Policy settings with the specified project. -* :ref:`atlas-api-cloudBackups-getExportBucket` - experimental: Returns one Export Bucket associated with the specified Project. -* :ref:`atlas-api-cloudBackups-getReplicaSetBackup` - experimental: Returns one snapshot from the specified cluster. -* :ref:`atlas-api-cloudBackups-getServerlessBackup` - experimental: Returns one snapshot of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-getServerlessBackupRestoreJob` - experimental: Returns one restore job for one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-getShardedClusterBackup` - experimental: Returns one snapshot of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listBackupExportJobs` - experimental: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. -* :ref:`atlas-api-cloudBackups-listBackupRestoreJobs` - experimental: Returns all cloud backup restore jobs for one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listExportBuckets` - experimental: Returns all Export Buckets associated with the specified Project. -* :ref:`atlas-api-cloudBackups-listReplicaSetBackups` - experimental: Returns all snapshots of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listServerlessBackupRestoreJobs` - experimental: Returns all restore jobs for one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-listServerlessBackups` - experimental: Returns all snapshots of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-listShardedClusterBackups` - experimental: Returns all snapshots of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-takeSnapshot` - experimental: Takes one on-demand snapshot for the specified cluster. -* :ref:`atlas-api-cloudBackups-updateBackupSchedule` - experimental: Updates the cloud backup schedule for one cluster within the specified project. -* :ref:`atlas-api-cloudBackups-updateDataProtectionSettings` - experimental: Updates the Backup Compliance Policy settings for the specified project. -* :ref:`atlas-api-cloudBackups-updateSnapshotRetention` - experimental: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-cloudBackups-cancelBackupRestoreJob` - `experimental `: Cancels one cloud backup restore job of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-createBackupExportJob` - `experimental `: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. +* :ref:`atlas-api-cloudBackups-createBackupRestoreJob` - `experimental `: Restores one snapshot of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-createExportBucket` - `experimental `: Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. +* :ref:`atlas-api-cloudBackups-createServerlessBackupRestoreJob` - `experimental `: Restores one snapshot of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-deleteAllBackupSchedules` - `experimental `: Removes all cloud backup schedules for the specified cluster. +* :ref:`atlas-api-cloudBackups-deleteExportBucket` - `experimental `: Deletes an Export Bucket. +* :ref:`atlas-api-cloudBackups-deleteReplicaSetBackup` - `experimental `: Removes the specified snapshot. +* :ref:`atlas-api-cloudBackups-deleteShardedClusterBackup` - `experimental `: Removes one snapshot of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-disableDataProtectionSettings` - `experimental `: Disables the Backup Compliance Policy settings with the specified project. +* :ref:`atlas-api-cloudBackups-getBackupExportJob` - `experimental `: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. +* :ref:`atlas-api-cloudBackups-getBackupRestoreJob` - `experimental `: Returns one cloud backup restore job for one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-getBackupSchedule` - `experimental `: Returns the cloud backup schedule for the specified cluster within the specified project. +* :ref:`atlas-api-cloudBackups-getDataProtectionSettings` - `experimental `: Returns the Backup Compliance Policy settings with the specified project. +* :ref:`atlas-api-cloudBackups-getExportBucket` - `experimental `: Returns one Export Bucket associated with the specified Project. +* :ref:`atlas-api-cloudBackups-getReplicaSetBackup` - `experimental `: Returns one snapshot from the specified cluster. +* :ref:`atlas-api-cloudBackups-getServerlessBackup` - `experimental `: Returns one snapshot of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-getServerlessBackupRestoreJob` - `experimental `: Returns one restore job for one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-getShardedClusterBackup` - `experimental `: Returns one snapshot of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listBackupExportJobs` - `experimental `: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. +* :ref:`atlas-api-cloudBackups-listBackupRestoreJobs` - `experimental `: Returns all cloud backup restore jobs for one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listExportBuckets` - `experimental `: Returns all Export Buckets associated with the specified Project. +* :ref:`atlas-api-cloudBackups-listReplicaSetBackups` - `experimental `: Returns all snapshots of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listServerlessBackupRestoreJobs` - `experimental `: Returns all restore jobs for one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-listServerlessBackups` - `experimental `: Returns all snapshots of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-listShardedClusterBackups` - `experimental `: Returns all snapshots of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-takeSnapshot` - `experimental `: Takes one on-demand snapshot for the specified cluster. +* :ref:`atlas-api-cloudBackups-updateBackupSchedule` - `experimental `: Updates the cloud backup schedule for one cluster within the specified project. +* :ref:`atlas-api-cloudBackups-updateDataProtectionSettings` - `experimental `: Updates the Backup Compliance Policy settings for the specified project. +* :ref:`atlas-api-cloudBackups-updateSnapshotRetention` - `experimental `: 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 e0082ccef4..1d4ad216bd 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 -experimental: Create one link-token that contains all the information required to complete the link. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'createLinkToken'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createLinkToken diff --git a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt index dddfac0912..e88df0b1c2 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 -experimental: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. +`experimental `: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. Please make sure to validate your migration before initiating it. You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource. NOTE: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster. This command is invoking the endpoint with OperationID: 'createPushMigration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createPushMigration diff --git a/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt b/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt index 1bb30248ff..b4aa4940a6 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 -experimental: Cut over the migrated cluster to MongoDB Atlas. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'cutoverMigration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/cutoverMigration diff --git a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt b/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt index a9dbafe69a..62393b5951 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 -experimental: Remove one organization link and its associated public API key. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'deleteLinkToken'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/deleteLinkToken diff --git a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt index 8c0e547511..9aedce4b5d 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 -experimental: Return details of one cluster migration job. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'getPushMigration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getPushMigration diff --git a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt b/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt index 8bc97c0fe9..4feee7c730 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 -experimental: Return the status of one migration validation job. +`experimental `: Return the status of one migration validation job. Your API Key must have the Organization Owner role to successfully call this resource. This command is invoking the endpoint with OperationID: 'getValidationStatus'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getValidationStatus diff --git a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt b/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt index d06f6a500c..8b10b07fdb 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 -experimental: Return all projects that you can migrate to the specified organization. +`experimental `: Return all projects that you can migrate to the specified organization. This command is invoking the endpoint with OperationID: 'listSourceProjects'. For more information about flags, format of --file and examples, see: 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 9b89932bf4..f721561a8c 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 -experimental: Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'validateMigration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateMigration diff --git a/docs/command/atlas-api-cloudMigrationService.txt b/docs/command/atlas-api-cloudMigrationService.txt index ff7374e576..6635b46daf 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 -experimental: Manages the Cloud Migration Service. +`experimental `: 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 +51,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudMigrationService-createLinkToken` - experimental: Create one link-token that contains all the information required to complete the link. -* :ref:`atlas-api-cloudMigrationService-createPushMigration` - experimental: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. -* :ref:`atlas-api-cloudMigrationService-cutoverMigration` - experimental: Cut over the migrated cluster to MongoDB Atlas. -* :ref:`atlas-api-cloudMigrationService-deleteLinkToken` - experimental: Remove one organization link and its associated public API key. -* :ref:`atlas-api-cloudMigrationService-getPushMigration` - experimental: Return details of one cluster migration job. -* :ref:`atlas-api-cloudMigrationService-getValidationStatus` - experimental: Return the status of one migration validation job. -* :ref:`atlas-api-cloudMigrationService-listSourceProjects` - experimental: Return all projects that you can migrate to the specified organization. -* :ref:`atlas-api-cloudMigrationService-validateMigration` - experimental: 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` - `experimental `: Create one link-token that contains all the information required to complete the link. +* :ref:`atlas-api-cloudMigrationService-createPushMigration` - `experimental `: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. +* :ref:`atlas-api-cloudMigrationService-cutoverMigration` - `experimental `: Cut over the migrated cluster to MongoDB Atlas. +* :ref:`atlas-api-cloudMigrationService-deleteLinkToken` - `experimental `: Remove one organization link and its associated public API key. +* :ref:`atlas-api-cloudMigrationService-getPushMigration` - `experimental `: Return details of one cluster migration job. +* :ref:`atlas-api-cloudMigrationService-getValidationStatus` - `experimental `: Return the status of one migration validation job. +* :ref:`atlas-api-cloudMigrationService-listSourceProjects` - `experimental `: Return all projects that you can migrate to the specified organization. +* :ref:`atlas-api-cloudMigrationService-validateMigration` - `experimental `: 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 c887be6825..1b3dfa8e42 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 -experimental: Grants access to the specified project for the specified access role. +`experimental `: Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. This is not required for GCP service account access. This command is invoking the endpoint with OperationID: 'authorizeCloudProviderAccessRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/authorizeCloudProviderAccessRole diff --git a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt index 46f94f9f00..d30efc264a 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 -experimental: Creates one access role for the specified cloud provider. +`experimental `: Creates one access role for the specified cloud provider. Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createCloudProviderAccessRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/createCloudProviderAccessRole diff --git a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt index 8e99349af8..a68603779a 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 -experimental: Revokes access to the specified project for the specified access role. +`experimental `: Revokes access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deauthorizeCloudProviderAccessRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/deauthorizeCloudProviderAccessRole diff --git a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt index 5f8098cd91..dae378ea37 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 -experimental: Returns the access role with the specified id and with access to the specified project. +`experimental `: Returns the access role with the specified id and with access to the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getCloudProviderAccessRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/getCloudProviderAccessRole diff --git a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt index 44a7f3c366..93691333a4 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 -experimental: Returns all cloud provider access roles with access to the specified project. +`experimental `: Returns all cloud provider access roles with access to the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'listCloudProviderAccessRoles'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/listCloudProviderAccessRoles diff --git a/docs/command/atlas-api-cloudProviderAccess.txt b/docs/command/atlas-api-cloudProviderAccess.txt index b37ae2b95d..ba72068364 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 -experimental: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. +`experimental `: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. Options ------- @@ -49,11 +49,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole` - experimental: Grants access to the specified project for the specified access role. -* :ref:`atlas-api-cloudProviderAccess-createCloudProviderAccessRole` - experimental: Creates one access role for the specified cloud provider. -* :ref:`atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole` - experimental: Revokes access to the specified project for the specified access role. -* :ref:`atlas-api-cloudProviderAccess-getCloudProviderAccessRole` - experimental: Returns the access role with the specified id and with access to the specified project. -* :ref:`atlas-api-cloudProviderAccess-listCloudProviderAccessRoles` - experimental: Returns all cloud provider access roles with access to the specified project. +* :ref:`atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole` - `experimental `: Grants access to the specified project for the specified access role. +* :ref:`atlas-api-cloudProviderAccess-createCloudProviderAccessRole` - `experimental `: Creates one access role for the specified cloud provider. +* :ref:`atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole` - `experimental `: Revokes access to the specified project for the specified access role. +* :ref:`atlas-api-cloudProviderAccess-getCloudProviderAccessRole` - `experimental `: Returns the access role with the specified id and with access to the specified project. +* :ref:`atlas-api-cloudProviderAccess-listCloudProviderAccessRoles` - `experimental `: 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 20d6f43816..70c6a07348 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 -experimental: Ends a cluster outage simulation. +`experimental `: Ends a cluster outage simulation. This command is invoking the endpoint with OperationID: 'endOutageSimulation'. For more information about flags, format of --file and examples, see: 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 0fac65bff4..85f448f600 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 -experimental: Returns one outage simulation for one cluster. +`experimental `: Returns one outage simulation for one cluster. This command is invoking the endpoint with OperationID: 'getOutageSimulation'. For more information about flags, format of --file and examples, see: 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 f71de5d7b8..fdadf2d307 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 -experimental: Starts a cluster outage simulation. +`experimental `: Starts a cluster outage simulation. This command is invoking the endpoint with OperationID: 'startOutageSimulation'. For more information about flags, format of --file and examples, see: 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 140defea68..1d77b31b23 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 -experimental: Returns, starts, or ends a cluster outage simulation. +`experimental `: Returns, starts, or ends a cluster outage simulation. Options ------- @@ -49,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-clusterOutageSimulation-endOutageSimulation` - experimental: Ends a cluster outage simulation. -* :ref:`atlas-api-clusterOutageSimulation-getOutageSimulation` - experimental: Returns one outage simulation for one cluster. -* :ref:`atlas-api-clusterOutageSimulation-startOutageSimulation` - experimental: Starts a cluster outage simulation. +* :ref:`atlas-api-clusterOutageSimulation-endOutageSimulation` - `experimental `: Ends a cluster outage simulation. +* :ref:`atlas-api-clusterOutageSimulation-getOutageSimulation` - `experimental `: Returns one outage simulation for one cluster. +* :ref:`atlas-api-clusterOutageSimulation-startOutageSimulation` - `experimental `: Starts a cluster outage simulation. .. toctree:: diff --git a/docs/command/atlas-api-clusters-createCluster.txt b/docs/command/atlas-api-clusters-createCluster.txt index a825313332..888262d2f3 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 -experimental: Creates one cluster in the specified project. +`experimental `: Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters. This command is invoking the endpoint with OperationID: 'createCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster diff --git a/docs/command/atlas-api-clusters-deleteCluster.txt b/docs/command/atlas-api-clusters-deleteCluster.txt index c9914ae647..9948a920f1 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 -experimental: Removes one cluster from the specified project. +`experimental `: Removes one cluster from the specified project. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters. This command is invoking the endpoint with OperationID: 'deleteCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/deleteCluster diff --git a/docs/command/atlas-api-clusters-getCluster.txt b/docs/command/atlas-api-clusters-getCluster.txt index 2f9ac4372c..456b87a373 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 -experimental: Returns the details for one cluster in the specified project. +`experimental `: Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. This command is invoking the endpoint with OperationID: 'getCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster diff --git a/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt index 1cbcddc0ab..61a5faa191 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 -experimental: Returns the advanced configuration details for one cluster in the specified project. +`experimental `: 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 API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getClusterAdvancedConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterAdvancedConfiguration diff --git a/docs/command/atlas-api-clusters-getClusterStatus.txt b/docs/command/atlas-api-clusters-getClusterStatus.txt index 5f9a8c788a..aca0d52275 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 -experimental: Returns the status of all changes that you made to the specified cluster in the specified project. +`experimental `: Returns the status of all changes that you made to the specified cluster in the specified project. Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getClusterStatus'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterStatus diff --git a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt b/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt index 411b92ef06..879a7a9079 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 -experimental: Checks the progress of loading the sample dataset into one cluster. +`experimental `: Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getSampleDatasetLoadStatus'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getSampleDatasetLoadStatus diff --git a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt index 09d9037292..a9f7f93250 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 -experimental: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. +`experimental `: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. This command is invoking the endpoint with OperationID: 'grantMongoDbEmployeeAccess'. For more information about flags, format of --file and examples, see: 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 6d3167ce0d..f62a2cc3c9 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 -experimental: Returns the list of regions available for the specified cloud provider at the specified tier. +`experimental `: Returns the list of regions available for the specified cloud provider at the specified tier. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listCloudProviderRegions'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listCloudProviderRegions diff --git a/docs/command/atlas-api-clusters-listClusters.txt b/docs/command/atlas-api-clusters-listClusters.txt index ee5a0ccac9..0d748141fe 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 -experimental: Returns the details for all clusters in the specific project to which you have access. +`experimental `: Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. This command is invoking the endpoint with OperationID: 'listClusters'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusters diff --git a/docs/command/atlas-api-clusters-listClustersForAllProjects.txt b/docs/command/atlas-api-clusters-listClustersForAllProjects.txt index 464bbe181a..b001a987c1 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 -experimental: Returns the details for all clusters in all projects to which you have access. +`experimental `: Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting API Key can have any cluster-level role. This command is invoking the endpoint with OperationID: 'listClustersForAllProjects'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClustersForAllProjects diff --git a/docs/command/atlas-api-clusters-loadSampleDataset.txt b/docs/command/atlas-api-clusters-loadSampleDataset.txt index 1546e8b49d..6055447871 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 -experimental: Requests loading the MongoDB sample dataset into the specified cluster. +`experimental `: Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'loadSampleDataset'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/loadSampleDataset diff --git a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt index 9585dac9e8..e2dfcaed3f 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 -experimental: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'pinFeatureCompatibilityVersion'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/pinFeatureCompatibilityVersion diff --git a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt index 8ccc1e7192..e96db40b00 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 -experimental: Revokes a previously granted MongoDB employee cluster access. +`experimental `: Revokes a previously granted MongoDB employee cluster access. This command is invoking the endpoint with OperationID: 'revokeMongoDbEmployeeAccess'. For more information about flags, format of --file and examples, see: 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 910c372be1..24b11e4ca3 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 -experimental: Starts a failover test for the specified cluster in the specified project. +`experimental `: Starts a failover test for the specified cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting API Key must have the Project Cluster Manager role. This command is invoking the endpoint with OperationID: 'testFailover'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/testFailover diff --git a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt index f0f299766d..71b51aba2e 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 -experimental: Unpins the current fixed Feature Compatibility Version (FCV). +`experimental `: Unpins the current fixed Feature Compatibility Version (FCV). This feature is not available for clusters on rapid release. This command is invoking the endpoint with OperationID: 'unpinFeatureCompatibilityVersion'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/unpinFeatureCompatibilityVersion diff --git a/docs/command/atlas-api-clusters-updateCluster.txt b/docs/command/atlas-api-clusters-updateCluster.txt index 8e63634425..334e2c0a43 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 -experimental: Updates the details for one cluster in the specified project. +`experimental `: Updates the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can update clusters with asymmetrically-sized shards. To update a cluster's termination protection, the requesting API Key must have the Project Owner role. For all other updates, the requesting API Key must have the Project Cluster Manager role. You can't modify a paused cluster (paused : true). You must call this endpoint to set paused : false. After this endpoint responds with paused : false, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters. This command is invoking the endpoint with OperationID: 'updateCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateCluster diff --git a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt index c9baa9229e..f774d9bbb3 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 -experimental: Updates the advanced configuration details for one cluster in the specified project. +`experimental `: Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting API Key must have the Project Cluster Manager role. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. This command is invoking the endpoint with OperationID: 'updateClusterAdvancedConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateClusterAdvancedConfiguration diff --git a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt b/docs/command/atlas-api-clusters-upgradeSharedCluster.txt index 38c912e1ef..514feda8cc 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 -experimental: Upgrades a shared-tier cluster to a dedicated cluster (M10+) in the specified project. +`experimental `: Upgrades a shared-tier cluster to a dedicated cluster (M10+) in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. Each project supports up to 25 clusters. This command is invoking the endpoint with OperationID: 'upgradeSharedCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedCluster diff --git a/docs/command/atlas-api-clusters-upgradeSharedClusterToServerless.txt b/docs/command/atlas-api-clusters-upgradeSharedClusterToServerless.txt index 4d3c536a3f..26dd295e63 100644 --- a/docs/command/atlas-api-clusters-upgradeSharedClusterToServerless.txt +++ b/docs/command/atlas-api-clusters-upgradeSharedClusterToServerless.txt @@ -12,7 +12,7 @@ atlas api clusters upgradeSharedClusterToServerless :depth: 1 :class: singlecol -experimental: Upgrades a shared-tier cluster to a serverless instance in the specified project. +`experimental `: Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. This command is invoking the endpoint with OperationID: 'upgradeSharedClusterToServerless'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedClusterToServerless diff --git a/docs/command/atlas-api-clusters.txt b/docs/command/atlas-api-clusters.txt index 3e1d352b38..4fcbbb0c4d 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 -experimental: Returns, adds, edits, and removes database deployments. +`experimental `: Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID. @@ -51,25 +51,25 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-clusters-createCluster` - experimental: Creates one cluster in the specified project. -* :ref:`atlas-api-clusters-deleteCluster` - experimental: Removes one cluster from the specified project. -* :ref:`atlas-api-clusters-getCluster` - experimental: Returns the details for one cluster in the specified project. -* :ref:`atlas-api-clusters-getClusterAdvancedConfiguration` - experimental: Returns the advanced configuration details for one cluster in the specified project. -* :ref:`atlas-api-clusters-getClusterStatus` - experimental: Returns the status of all changes that you made to the specified cluster in the specified project. -* :ref:`atlas-api-clusters-getSampleDatasetLoadStatus` - experimental: Checks the progress of loading the sample dataset into one cluster. -* :ref:`atlas-api-clusters-grantMongoDbEmployeeAccess` - experimental: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. -* :ref:`atlas-api-clusters-listCloudProviderRegions` - experimental: Returns the list of regions available for the specified cloud provider at the specified tier. -* :ref:`atlas-api-clusters-listClusters` - experimental: Returns the details for all clusters in the specific project to which you have access. -* :ref:`atlas-api-clusters-listClustersForAllProjects` - experimental: Returns the details for all clusters in all projects to which you have access. -* :ref:`atlas-api-clusters-loadSampleDataset` - experimental: Requests loading the MongoDB sample dataset into the specified cluster. -* :ref:`atlas-api-clusters-pinFeatureCompatibilityVersion` - experimental: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. -* :ref:`atlas-api-clusters-revokeMongoDbEmployeeAccess` - experimental: Revokes a previously granted MongoDB employee cluster access. -* :ref:`atlas-api-clusters-testFailover` - experimental: Starts a failover test for the specified cluster in the specified project. -* :ref:`atlas-api-clusters-unpinFeatureCompatibilityVersion` - experimental: Unpins the current fixed Feature Compatibility Version (FCV). -* :ref:`atlas-api-clusters-updateCluster` - experimental: Updates the details for one cluster in the specified project. -* :ref:`atlas-api-clusters-updateClusterAdvancedConfiguration` - experimental: Updates the advanced configuration details for one cluster in the specified project. -* :ref:`atlas-api-clusters-upgradeSharedCluster` - experimental: Upgrades a shared-tier cluster to a dedicated cluster (M10+) in the specified project. -* :ref:`atlas-api-clusters-upgradeSharedClusterToServerless` - experimental: Upgrades a shared-tier cluster to a serverless instance in the specified project. +* :ref:`atlas-api-clusters-createCluster` - `experimental `: Creates one cluster in the specified project. +* :ref:`atlas-api-clusters-deleteCluster` - `experimental `: Removes one cluster from the specified project. +* :ref:`atlas-api-clusters-getCluster` - `experimental `: Returns the details for one cluster in the specified project. +* :ref:`atlas-api-clusters-getClusterAdvancedConfiguration` - `experimental `: Returns the advanced configuration details for one cluster in the specified project. +* :ref:`atlas-api-clusters-getClusterStatus` - `experimental `: Returns the status of all changes that you made to the specified cluster in the specified project. +* :ref:`atlas-api-clusters-getSampleDatasetLoadStatus` - `experimental `: Checks the progress of loading the sample dataset into one cluster. +* :ref:`atlas-api-clusters-grantMongoDbEmployeeAccess` - `experimental `: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. +* :ref:`atlas-api-clusters-listCloudProviderRegions` - `experimental `: Returns the list of regions available for the specified cloud provider at the specified tier. +* :ref:`atlas-api-clusters-listClusters` - `experimental `: Returns the details for all clusters in the specific project to which you have access. +* :ref:`atlas-api-clusters-listClustersForAllProjects` - `experimental `: Returns the details for all clusters in all projects to which you have access. +* :ref:`atlas-api-clusters-loadSampleDataset` - `experimental `: Requests loading the MongoDB sample dataset into the specified cluster. +* :ref:`atlas-api-clusters-pinFeatureCompatibilityVersion` - `experimental `: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. +* :ref:`atlas-api-clusters-revokeMongoDbEmployeeAccess` - `experimental `: Revokes a previously granted MongoDB employee cluster access. +* :ref:`atlas-api-clusters-testFailover` - `experimental `: Starts a failover test for the specified cluster in the specified project. +* :ref:`atlas-api-clusters-unpinFeatureCompatibilityVersion` - `experimental `: Unpins the current fixed Feature Compatibility Version (FCV). +* :ref:`atlas-api-clusters-updateCluster` - `experimental `: Updates the details for one cluster in the specified project. +* :ref:`atlas-api-clusters-updateClusterAdvancedConfiguration` - `experimental `: Updates the advanced configuration details for one cluster in the specified project. +* :ref:`atlas-api-clusters-upgradeSharedCluster` - `experimental `: Upgrades a shared-tier cluster to a dedicated cluster (M10+) in the specified project. +* :ref:`atlas-api-clusters-upgradeSharedClusterToServerless` - `experimental `: Upgrades a shared-tier cluster to a serverless instance in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt index b52c6007c8..38740913c1 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 -experimental: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. +`experimental `: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. This command is invoking the endpoint with OperationID: 'getCollStatsLatencyNamespaceClusterMeasurements'. For more information about flags, format of --file and examples, see: 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 736b4b5f2b..2772fb3ff9 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 -experimental: Get a list of the Coll Stats Latency process-level measurements for the given namespace +`experimental `: Get a list of the Coll Stats Latency process-level measurements for the given namespace This command is invoking the endpoint with OperationID: 'getCollStatsLatencyNamespaceHostMeasurements'. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt index 9581bd3bfc..9912d0dc66 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 -experimental: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. +`experimental `: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. This command is invoking the endpoint with OperationID: 'getCollStatsLatencyNamespaceMetrics'. For more information about flags, format of --file and examples, see: 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 cc7399b90b..520707b447 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 -experimental: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. +`experimental `: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. This command is invoking the endpoint with OperationID: 'getCollStatsLatencyNamespacesForCluster'. For more information about flags, format of --file and examples, see: 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 394e802fb2..5f6ed2b7ca 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 -experimental: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. +`experimental `: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. This command is invoking the endpoint with OperationID: 'getCollStatsLatencyNamespacesForHost'. For more information about flags, format of --file and examples, see: 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 a8380eb1dc..b88f1edba4 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 -experimental: Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. +`experimental `: 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 invoking the endpoint with OperationID: 'getPinnedNamespaces'. For more information about flags, format of --file and examples, see: 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 07f0322cf9..a8f6e066c1 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 -experimental: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster +`experimental `: 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 invoking the endpoint with OperationID: 'pinNamespacesPatch'. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt index 8df2f19300..8b4f99cac6 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 -experimental: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'pinNamespacesPut'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPut diff --git a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt index dbe89f2f96..2884333a9b 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 -experimental: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster +`experimental `: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster This command is invoking the endpoint with OperationID: 'unpinNamespaces'. diff --git a/docs/command/atlas-api-collectionLevelMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics.txt index 5fb5687eb4..f95ae2d728 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 -experimental: Returns, adds, and edits pinned namespaces for the specified cluster or process. +`experimental `: Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level latency metric data. @@ -51,19 +51,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements` - experimental: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements` - experimental: Get a list of the Coll Stats Latency process-level measurements for the given namespace +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements` - `experimental `: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements` - `experimental `: Get a list of the Coll Stats Latency process-level measurements for the given namespace This command is invoking the endpoint with OperationID: 'getCollStatsLatencyNamespaceHostMeasurements'. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics` - experimental: 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` - experimental: 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` - experimental: 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` - experimental: 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` - experimental: 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-getCollStatsLatencyNamespaceMetrics` - `experimental `: 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` - `experimental `: 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` - `experimental `: 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` - `experimental `: 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` - `experimental `: 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 invoking the endpoint with OperationID: 'pinNamespacesPatch'. -* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPut` - experimental: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. -* :ref:`atlas-api-collectionLevelMetrics-unpinNamespaces` - experimental: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster +* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPut` - `experimental `: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +* :ref:`atlas-api-collectionLevelMetrics-unpinNamespaces` - `experimental `: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster This command is invoking the endpoint with OperationID: 'unpinNamespaces'. diff --git a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt index 259db6f6fa..a5da502463 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 -experimental: Creates one custom role in the specified project. +`experimental `: Creates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createCustomDatabaseRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/createCustomDatabaseRole diff --git a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt index 8f7beb4f75..869b4e8b68 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 -experimental: Removes one custom role from the specified project. +`experimental `: Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting API Key must have the Project Atlas Admin role. This command is invoking the endpoint with OperationID: 'deleteCustomDatabaseRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/deleteCustomDatabaseRole diff --git a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt index 8f40936805..8bb4b807ba 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 -experimental: Returns one custom role for the specified project. +`experimental `: Returns one custom role for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getCustomDatabaseRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/getCustomDatabaseRole diff --git a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt index 25fa52dd2f..188bdfcd06 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 -experimental: Returns all custom roles for the specified project. +`experimental `: Returns all custom roles for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listCustomDatabaseRoles'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/listCustomDatabaseRoles diff --git a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt index c57afdffbb..3da7a3cee7 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 -experimental: Updates one custom role in the specified project. +`experimental `: Updates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateCustomDatabaseRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/updateCustomDatabaseRole diff --git a/docs/command/atlas-api-customDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles.txt index 39270958c0..1ca325b225 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 -experimental: Returns, adds, edits, and removes custom database user privilege roles. +`experimental `: 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 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-customDatabaseRoles-createCustomDatabaseRole` - experimental: Creates one custom role in the specified project. -* :ref:`atlas-api-customDatabaseRoles-deleteCustomDatabaseRole` - experimental: Removes one custom role from the specified project. -* :ref:`atlas-api-customDatabaseRoles-getCustomDatabaseRole` - experimental: Returns one custom role for the specified project. -* :ref:`atlas-api-customDatabaseRoles-listCustomDatabaseRoles` - experimental: Returns all custom roles for the specified project. -* :ref:`atlas-api-customDatabaseRoles-updateCustomDatabaseRole` - experimental: Updates one custom role in the specified project. +* :ref:`atlas-api-customDatabaseRoles-createCustomDatabaseRole` - `experimental `: Creates one custom role in the specified project. +* :ref:`atlas-api-customDatabaseRoles-deleteCustomDatabaseRole` - `experimental `: Removes one custom role from the specified project. +* :ref:`atlas-api-customDatabaseRoles-getCustomDatabaseRole` - `experimental `: Returns one custom role for the specified project. +* :ref:`atlas-api-customDatabaseRoles-listCustomDatabaseRoles` - `experimental `: Returns all custom roles for the specified project. +* :ref:`atlas-api-customDatabaseRoles-updateCustomDatabaseRole` - `experimental `: 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 aa41b290d4..0ee28570d8 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 -experimental: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. +`experimental `: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. us-east-1 is com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4. us-west-1 is com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb. eu-west-1 is com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e. eu-west-2 is com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9. eu-central-1 is com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d. sa-east-1 is com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044. ap-southeast-2 is com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e. ap-south-1 is com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'createDataFederationPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createDataFederationPrivateEndpoint diff --git a/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt index 7a44f3faf8..2cc2592af5 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 -experimental: Creates one federated database instance in the specified project. +`experimental `: Creates one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'createFederatedDatabase'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createFederatedDatabase diff --git a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt b/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt index f44741697b..e887852650 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 -experimental: Creates or updates one query limit for one federated database instance. +`experimental `: Creates or updates one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createOneDataFederationQueryLimit'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createOneDataFederationQueryLimit diff --git a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt index 69e5a044a4..001ca43445 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 -experimental: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. +`experimental `: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteDataFederationPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteDataFederationPrivateEndpoint diff --git a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt index da4f00841d..dcc6b839f1 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 -experimental: Removes one federated database instance from the specified project. +`experimental `: Removes one federated database instance from the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'deleteFederatedDatabase'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteFederatedDatabase diff --git a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt b/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt index 32bf86bd10..24bc852d44 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 -experimental: Deletes one query limit for one federated database instance. +`experimental `: Deletes one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteOneDataFederationInstanceQueryLimit'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteOneDataFederationInstanceQueryLimit diff --git a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt b/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt index 9ce01c274c..7c50c2bc1b 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 -experimental: Downloads the query logs for the specified federated database instance. +`experimental `: Downloads the query logs for the specified federated database instance. To use this resource, the requesting API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". This command is invoking the endpoint with OperationID: 'downloadFederatedDatabaseQueryLogs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadFederatedDatabaseQueryLogs diff --git a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt index baf836e668..cd3738c84e 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 -experimental: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. +`experimental `: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'getDataFederationPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getDataFederationPrivateEndpoint diff --git a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt index bfc23374ec..6678d44c35 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 -experimental: Returns the details of one federated database instance within the specified project. +`experimental `: Returns the details of one federated database instance within the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'getFederatedDatabase'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getFederatedDatabase diff --git a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt b/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt index 9eb105e8b2..7bcc4759bc 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 -experimental: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. +`experimental `: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'listDataFederationPrivateEndpoints'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listDataFederationPrivateEndpoints diff --git a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt b/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt index c86fabb5e9..62ab6c81b5 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 -experimental: Returns the details of all federated database instances in the specified project. +`experimental `: Returns the details of all federated database instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only or higher role. This command is invoking the endpoint with OperationID: 'listFederatedDatabases'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listFederatedDatabases diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt index 09444f7f6d..057250a8e9 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 -experimental: Returns the details of one query limit for the specified federated database instance in the specified project. +`experimental `: Returns the details of one query limit for the specified federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'returnFederatedDatabaseQueryLimit'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimit diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt index e36b65298d..650937d361 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 -experimental: Returns query limits for a federated databases instance in the specified project. +`experimental `: Returns query limits for a federated databases instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'returnFederatedDatabaseQueryLimits'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimits diff --git a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt index c068ac00ef..184a24eb70 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 -experimental: Updates the details of one federated database instance in the specified project. +`experimental `: Updates the details of one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or higher role. This command is invoking the endpoint with OperationID: 'updateFederatedDatabase'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/updateFederatedDatabase diff --git a/docs/command/atlas-api-dataFederation.txt b/docs/command/atlas-api-dataFederation.txt index 5fa532ec5c..295f35aa07 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 -experimental: Returns, adds, edits, and removes Federated Database Instances. +`experimental `: 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 +51,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-dataFederation-createDataFederationPrivateEndpoint` - experimental: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. -* :ref:`atlas-api-dataFederation-createFederatedDatabase` - experimental: Creates one federated database instance in the specified project. -* :ref:`atlas-api-dataFederation-createOneDataFederationQueryLimit` - experimental: Creates or updates one query limit for one federated database instance. -* :ref:`atlas-api-dataFederation-deleteDataFederationPrivateEndpoint` - experimental: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-deleteFederatedDatabase` - experimental: Removes one federated database instance from the specified project. -* :ref:`atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit` - experimental: Deletes one query limit for one federated database instance. -* :ref:`atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs` - experimental: Downloads the query logs for the specified federated database instance. -* :ref:`atlas-api-dataFederation-getDataFederationPrivateEndpoint` - experimental: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-getFederatedDatabase` - experimental: Returns the details of one federated database instance within the specified project. -* :ref:`atlas-api-dataFederation-listDataFederationPrivateEndpoints` - experimental: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-listFederatedDatabases` - experimental: Returns the details of all federated database instances in the specified project. -* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimit` - experimental: Returns the details of one query limit for the specified federated database instance in the specified project. -* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimits` - experimental: Returns query limits for a federated databases instance in the specified project. -* :ref:`atlas-api-dataFederation-updateFederatedDatabase` - experimental: Updates the details of one federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-createDataFederationPrivateEndpoint` - `experimental `: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. +* :ref:`atlas-api-dataFederation-createFederatedDatabase` - `experimental `: Creates one federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-createOneDataFederationQueryLimit` - `experimental `: Creates or updates one query limit for one federated database instance. +* :ref:`atlas-api-dataFederation-deleteDataFederationPrivateEndpoint` - `experimental `: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-deleteFederatedDatabase` - `experimental `: Removes one federated database instance from the specified project. +* :ref:`atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit` - `experimental `: Deletes one query limit for one federated database instance. +* :ref:`atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs` - `experimental `: Downloads the query logs for the specified federated database instance. +* :ref:`atlas-api-dataFederation-getDataFederationPrivateEndpoint` - `experimental `: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-getFederatedDatabase` - `experimental `: Returns the details of one federated database instance within the specified project. +* :ref:`atlas-api-dataFederation-listDataFederationPrivateEndpoints` - `experimental `: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-listFederatedDatabases` - `experimental `: Returns the details of all federated database instances in the specified project. +* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimit` - `experimental `: Returns the details of one query limit for the specified federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimits` - `experimental `: Returns query limits for a federated databases instance in the specified project. +* :ref:`atlas-api-dataFederation-updateFederatedDatabase` - `experimental `: 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 935e861f1d..fa849ff9a6 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 -experimental: Creates one Data Lake Pipeline. +`experimental `: Creates one Data Lake Pipeline. This command is invoking the endpoint with OperationID: 'createPipeline'. For more information about flags, format of --file and examples, see: 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 2d99cb82c2..dad8070c22 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 -experimental: Removes one Data Lake Pipeline. +`experimental `: Removes one Data Lake Pipeline. This command is invoking the endpoint with OperationID: 'deletePipeline'. For more information about flags, format of --file and examples, see: 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 b4bcf94eac..6db087ec4d 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 -experimental: Deletes dataset that Atlas generated during the specified pipeline run. +`experimental `: Deletes dataset that Atlas generated during the specified pipeline run. This command is invoking the endpoint with OperationID: 'deletePipelineRunDataset'. For more information about flags, format of --file and examples, see: 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 21ed791a9f..86582dbfa8 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 -experimental: Returns the details of one Data Lake Pipeline within the specified project. +`experimental `: Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPipeline'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipeline diff --git a/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt b/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt index 8308ccda44..d191bd35ee 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 -experimental: Returns the details of one Data Lake Pipeline run within the specified project. +`experimental `: Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPipelineRun'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipelineRun diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt index 33eb90088a..1612242554 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 -experimental: Returns a list of past Data Lake Pipeline runs. +`experimental `: Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPipelineRuns'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineRuns diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt index 76a4933433..01daccbb48 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 -experimental: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. +`experimental `: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPipelineSchedules'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSchedules diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt index 65d44c243e..cfd22ea365 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 -experimental: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. +`experimental `: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPipelineSnapshots'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSnapshots diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelines.txt b/docs/command/atlas-api-dataLakePipelines-listPipelines.txt index b56763f8a3..eecfff6ff4 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 -experimental: Returns a list of Data Lake Pipelines. +`experimental `: Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPipelines'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelines diff --git a/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt b/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt index 445983326f..e96c5bef26 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 -experimental: Pauses ingestion for a Data Lake Pipeline within the specified project. +`experimental `: Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'pausePipeline'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/pausePipeline diff --git a/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt b/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt index f8f588c2ef..f6583d00e6 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 -experimental: Resumes ingestion for a Data Lake Pipeline within the specified project. +`experimental `: Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'resumePipeline'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/resumePipeline diff --git a/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt b/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt index 8263fa74ae..f848559bec 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 -experimental: Triggers a Data Lake Pipeline ingestion of a specified snapshot. +`experimental `: Triggers a Data Lake Pipeline ingestion of a specified snapshot. This command is invoking the endpoint with OperationID: 'triggerSnapshotIngestion'. For more information about flags, format of --file and examples, see: 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 4c88b96e6d..156f88bb22 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 -experimental: Updates one Data Lake Pipeline. +`experimental `: Updates one Data Lake Pipeline. This command is invoking the endpoint with OperationID: 'updatePipeline'. For more information about flags, format of --file and examples, see: 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 c915c5a66e..1adf38d09d 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 -experimental: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. +`experimental `: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. Options ------- @@ -49,19 +49,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-dataLakePipelines-createPipeline` - experimental: Creates one Data Lake Pipeline. -* :ref:`atlas-api-dataLakePipelines-deletePipeline` - experimental: Removes one Data Lake Pipeline. -* :ref:`atlas-api-dataLakePipelines-deletePipelineRunDataset` - experimental: Deletes dataset that Atlas generated during the specified pipeline run. -* :ref:`atlas-api-dataLakePipelines-getPipeline` - experimental: Returns the details of one Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-getPipelineRun` - experimental: Returns the details of one Data Lake Pipeline run within the specified project. -* :ref:`atlas-api-dataLakePipelines-listPipelineRuns` - experimental: Returns a list of past Data Lake Pipeline runs. -* :ref:`atlas-api-dataLakePipelines-listPipelineSchedules` - experimental: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. -* :ref:`atlas-api-dataLakePipelines-listPipelineSnapshots` - experimental: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. -* :ref:`atlas-api-dataLakePipelines-listPipelines` - experimental: Returns a list of Data Lake Pipelines. -* :ref:`atlas-api-dataLakePipelines-pausePipeline` - experimental: Pauses ingestion for a Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-resumePipeline` - experimental: Resumes ingestion for a Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-triggerSnapshotIngestion` - experimental: Triggers a Data Lake Pipeline ingestion of a specified snapshot. -* :ref:`atlas-api-dataLakePipelines-updatePipeline` - experimental: Updates one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-createPipeline` - `experimental `: Creates one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-deletePipeline` - `experimental `: Removes one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-deletePipelineRunDataset` - `experimental `: Deletes dataset that Atlas generated during the specified pipeline run. +* :ref:`atlas-api-dataLakePipelines-getPipeline` - `experimental `: Returns the details of one Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-getPipelineRun` - `experimental `: Returns the details of one Data Lake Pipeline run within the specified project. +* :ref:`atlas-api-dataLakePipelines-listPipelineRuns` - `experimental `: Returns a list of past Data Lake Pipeline runs. +* :ref:`atlas-api-dataLakePipelines-listPipelineSchedules` - `experimental `: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. +* :ref:`atlas-api-dataLakePipelines-listPipelineSnapshots` - `experimental `: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. +* :ref:`atlas-api-dataLakePipelines-listPipelines` - `experimental `: Returns a list of Data Lake Pipelines. +* :ref:`atlas-api-dataLakePipelines-pausePipeline` - `experimental `: Pauses ingestion for a Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-resumePipeline` - `experimental `: Resumes ingestion for a Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-triggerSnapshotIngestion` - `experimental `: Triggers a Data Lake Pipeline ingestion of a specified snapshot. +* :ref:`atlas-api-dataLakePipelines-updatePipeline` - `experimental `: 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 7c910f209c..f019e60e67 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 -experimental: Creates one database user in the specified project. +`experimental `: 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 API Key must have the Project Owner or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'createDatabaseUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/createDatabaseUser diff --git a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt index c35aed78f5..c37ee36ad3 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 -experimental: Removes one database user from the specified project. +`experimental `: Removes one database user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteDatabaseUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/deleteDatabaseUser diff --git a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt index c78a436472..0148a7ae62 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 -experimental: Returns one database user that belong to the specified project. +`experimental `: Returns one database user that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getDatabaseUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/getDatabaseUser diff --git a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt index fc1000890b..07455fee7c 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 -experimental: Returns all database users that belong to the specified project. +`experimental `: Returns all database users that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listDatabaseUsers'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/listDatabaseUsers diff --git a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt index 166a594f4f..7558d02270 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 -experimental: Updates one database user that belongs to the specified project. +`experimental `: Updates one database user that belongs to the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'updateDatabaseUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/updateDatabaseUser diff --git a/docs/command/atlas-api-databaseUsers.txt b/docs/command/atlas-api-databaseUsers.txt index 1d0b68ec27..4a05b9cd52 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 -experimental: Returns, adds, edits, and removes database users. +`experimental `: Returns, adds, edits, and removes database users. Options ------- @@ -49,11 +49,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-databaseUsers-createDatabaseUser` - experimental: Creates one database user in the specified project. -* :ref:`atlas-api-databaseUsers-deleteDatabaseUser` - experimental: Removes one database user from the specified project. -* :ref:`atlas-api-databaseUsers-getDatabaseUser` - experimental: Returns one database user that belong to the specified project. -* :ref:`atlas-api-databaseUsers-listDatabaseUsers` - experimental: Returns all database users that belong to the specified project. -* :ref:`atlas-api-databaseUsers-updateDatabaseUser` - experimental: Updates one database user that belongs to the specified project. +* :ref:`atlas-api-databaseUsers-createDatabaseUser` - `experimental `: Creates one database user in the specified project. +* :ref:`atlas-api-databaseUsers-deleteDatabaseUser` - `experimental `: Removes one database user from the specified project. +* :ref:`atlas-api-databaseUsers-getDatabaseUser` - `experimental `: Returns one database user that belong to the specified project. +* :ref:`atlas-api-databaseUsers-listDatabaseUsers` - `experimental `: Returns all database users that belong to the specified project. +* :ref:`atlas-api-databaseUsers-updateDatabaseUser` - `experimental `: 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 5c076a45db..aa4890439b 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 -experimental: Creates a private endpoint in the specified region for encryption at rest using customer key management. +`experimental `: Creates a private endpoint in the specified region for encryption at rest using customer key management. This command is invoking the endpoint with OperationID: 'createEncryptionAtRestPrivateEndpoint'. For more information about flags, format of --file and examples, see: 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 aa13278174..e7bac1cb09 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 -experimental: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. +`experimental `: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Owner role. LIMITED TO M10 OR GREATER: MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater. This command is invoking the endpoint with OperationID: 'getEncryptionAtRest'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRest diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt index 6fc409e7a1..7600eadc6e 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 -experimental: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +`experimental `: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. This command is invoking the endpoint with OperationID: 'getEncryptionAtRestPrivateEndpoint'. For more information about flags, format of --file and examples, see: 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 2590bb86cc..4ce99ce2b2 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 -experimental: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. +`experimental `: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. This command is invoking the endpoint with OperationID: 'getEncryptionAtRestPrivateEndpointsForCloudProvider'. For more information about flags, format of --file and examples, see: 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 2356e35e50..f06e5580e1 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 -experimental: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +`experimental `: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. This command is invoking the endpoint with OperationID: 'requestEncryptionAtRestPrivateEndpointDeletion'. For more information about flags, format of --file and examples, see: 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 1abffd435c..1438c67e43 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 -experimental: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. +`experimental `: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Owner role. This feature isn't available for M0 free clusters, M2, M5, or serverless clusters. After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management. This command is invoking the endpoint with OperationID: 'updateEncryptionAtRest'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/updateEncryptionAtRest diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt index a59b15999c..e3cc919a44 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 -experimental: Returns and edits the Encryption at Rest using Customer Key Management configuration. +`experimental `: 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 +51,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint` - experimental: Creates a private endpoint in the specified region for encryption at rest using customer key management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest` - experimental: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint` - experimental: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider` - experimental: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion` - experimental: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest` - experimental: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint` - `experimental `: Creates a private endpoint in the specified region for encryption at rest using customer key management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest` - `experimental `: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint` - `experimental `: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider` - `experimental `: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion` - `experimental `: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest` - `experimental `: 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 3bad4bb161..babf404422 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 -experimental: Returns one event for the specified organization. +`experimental `: Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'getOrganizationEvent'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getOrganizationEvent diff --git a/docs/command/atlas-api-events-getProjectEvent.txt b/docs/command/atlas-api-events-getProjectEvent.txt index 35ee917ee2..915a0ebf76 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 -experimental: Returns one event for the specified project. +`experimental `: Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'getProjectEvent'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getProjectEvent diff --git a/docs/command/atlas-api-events-listEventTypes.txt b/docs/command/atlas-api-events-listEventTypes.txt index bbd18da9da..b03b37058f 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 -experimental: Returns a list of all event types, along with a description and additional metadata about each event. +`experimental `: Returns a list of all event types, along with a description and additional metadata about each event. This command is invoking the endpoint with OperationID: 'listEventTypes'. For more information about flags, format of --file and examples, see: 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 58b43eec89..2da79903fd 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 -experimental: Returns all events for the specified organization. +`experimental `: Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listOrganizationEvents'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrganizationEvents diff --git a/docs/command/atlas-api-events-listProjectEvents.txt b/docs/command/atlas-api-events-listProjectEvents.txt index 1dae369085..161f73ff00 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 -experimental: Returns all events for the specified project. +`experimental `: Returns all events for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listProjectEvents'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listProjectEvents diff --git a/docs/command/atlas-api-events.txt b/docs/command/atlas-api-events.txt index 1a952b87a7..a9c4c26a0f 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 -experimental: Returns events. +`experimental `: Returns events. This collection remains under revision and may change. @@ -51,11 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-events-getOrganizationEvent` - experimental: Returns one event for the specified organization. -* :ref:`atlas-api-events-getProjectEvent` - experimental: Returns one event for the specified project. -* :ref:`atlas-api-events-listEventTypes` - experimental: Returns a list of all event types, along with a description and additional metadata about each event. -* :ref:`atlas-api-events-listOrganizationEvents` - experimental: Returns all events for the specified organization. -* :ref:`atlas-api-events-listProjectEvents` - experimental: Returns all events for the specified project. +* :ref:`atlas-api-events-getOrganizationEvent` - `experimental `: Returns one event for the specified organization. +* :ref:`atlas-api-events-getProjectEvent` - `experimental `: Returns one event for the specified project. +* :ref:`atlas-api-events-listEventTypes` - `experimental `: Returns a list of all event types, along with a description and additional metadata about each event. +* :ref:`atlas-api-events-listOrganizationEvents` - `experimental `: Returns all events for the specified organization. +* :ref:`atlas-api-events-listProjectEvents` - `experimental `: 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 d2fd1a36c6..15e3cad92c 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 -experimental: Creates one identity provider within the specified federation. +`experimental `: Creates one identity provider within the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. Note: This resource only supports the creation of OIDC identity providers. This command is invoking the endpoint with OperationID: 'createIdentityProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createIdentityProvider diff --git a/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt index c12aad1dde..33a0e0d72e 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 -experimental: Adds one role mapping to the specified organization in the specified federation. +`experimental `: Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'createRoleMapping'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createRoleMapping diff --git a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt b/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt index 192078b37b..e21241b0c2 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 -experimental: Deletes the federation settings instance and all associated data, including identity providers and domains. +`experimental `: Deletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting API Key must have the Organization Owner role in the last remaining connected organization. Note: requests to this resource will fail if there is more than one connected organization in the federation. This command is invoking the endpoint with OperationID: 'deleteFederationApp'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationApp diff --git a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt index c67c3fc303..4a33b98428 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 -experimental: Deletes one identity provider in the specified federation. +`experimental `: Deletes one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. Note: Requests to this resource will fail if the identity provider has any connected organizations. Before deleting an identity provider, disconnect all organizations and confirm that no organization in your account uses this identity provider. To learn more, see Manage Organization Mapping for Federated Authentication. This command is invoking the endpoint with OperationID: 'deleteIdentityProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteIdentityProvider diff --git a/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt index e611e99175..c36a612ecb 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 -experimental: Removes one role mapping in the specified organization from the specified federation. +`experimental `: Removes one role mapping in the specified organization from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'deleteRoleMapping'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteRoleMapping diff --git a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt index a493e8d603..e54b388d58 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 -experimental: Returns the specified connected org config from the specified federation. +`experimental `: Returns the specified connected org config from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. This command is invoking the endpoint with OperationID: 'getConnectedOrgConfig'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getConnectedOrgConfig diff --git a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt index 1e751e8abe..dbbbcd3e14 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 -experimental: Returns information about the federation settings for the specified organization. +`experimental `: Returns information about the federation settings for the specified organization. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. This command is invoking the endpoint with OperationID: 'getFederationSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettings diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt index 46febd4dcf..715cba2e3d 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 -experimental: Returns one identity provider in the specified federation by the identity provider's id. +`experimental `: Returns one identity provider in the specified federation by the identity provider's id. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. This command is invoking the endpoint with OperationID: 'getIdentityProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProvider diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt index 8fb305313c..4089e7406e 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 -experimental: Returns the metadata of one identity provider in the specified federation. +`experimental `: Returns the metadata of one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. This command is invoking the endpoint with OperationID: 'getIdentityProviderMetadata'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProviderMetadata diff --git a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt index 5efb5b6e38..3063a94533 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 -experimental: Returns one role mapping from the specified organization in the specified federation. +`experimental `: Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'getRoleMapping'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getRoleMapping diff --git a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt index 075eaaf12b..b1cab70ecd 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 -experimental: Returns all connected org configs in the specified federation. +`experimental `: Returns all connected org configs in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected orgs. This command is invoking the endpoint with OperationID: 'listConnectedOrgConfigs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listConnectedOrgConfigs diff --git a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt index 8fc4a3f897..96da9998fe 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 -experimental: Returns all identity providers with the provided protocol and type in the specified federation. +`experimental `: Returns all identity providers with the provided protocol and type in the specified federation. If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. This command is invoking the endpoint with OperationID: 'listIdentityProviders'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listIdentityProviders diff --git a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt index 4502ee3da9..5e9fe14f53 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 -experimental: Returns all role mappings from the specified organization in the specified federation. +`experimental `: Returns all role mappings from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'listRoleMappings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listRoleMappings diff --git a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt index 440dded3a6..2fab92adcd 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 -experimental: Removes one connected organization configuration from the specified federation. +`experimental `: Removes one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation. This command is invoking the endpoint with OperationID: 'removeConnectedOrgConfig'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/removeConnectedOrgConfig diff --git a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt index f779d32b7b..a03ea71062 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 -experimental: Revokes the JWKS tokens from the requested OIDC identity provider. +`experimental `: Revokes the JWKS tokens from the requested OIDC identity provider. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. Note: Revoking your JWKS tokens immediately refreshes your IdP public keys from all your Atlas clusters, invalidating previously signed access tokens and logging out all users. You may need to restart your MongoDB clients. All organizations connected to the identity provider will be affected. To learn more, see Configure OIDC Authorization. This command is invoking the endpoint with OperationID: 'revokeJwksFromIdentityProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/revokeJwksFromIdentityProvider diff --git a/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt index 8a92e09a7b..704f4741b5 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 -experimental: Updates one connected organization configuration from the specified federation. +`experimental `: Updates one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. Note If the organization configuration has no associated identity provider, you can't use this resource to update role mappings or post authorization role grants. Note: The domainRestrictionEnabled field defaults to false if not provided in the request. Note: If the identityProviderId field is not provided, you will disconnect the organization and the identity provider. Note: Currently connected data access identity providers missing from the dataAccessIdentityProviderIds field will be disconnected. This command is invoking the endpoint with OperationID: 'updateConnectedOrgConfig'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig diff --git a/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt index be3657d908..3801a5f6be 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 -experimental: Updates one identity provider in the specified federation. +`experimental `: Updates one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. Note: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database. This command is invoking the endpoint with OperationID: 'updateIdentityProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateIdentityProvider diff --git a/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt index eea4b15ead..0a341ecd48 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 -experimental: Updates one role mapping in the specified organization in the specified federation. +`experimental `: Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'updateRoleMapping'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateRoleMapping diff --git a/docs/command/atlas-api-federatedAuthentication.txt b/docs/command/atlas-api-federatedAuthentication.txt index ac45a2f7c5..470cf98cbe 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 -experimental: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. +`experimental `: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. Options ------- @@ -49,24 +49,24 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-federatedAuthentication-createIdentityProvider` - experimental: Creates one identity provider within the specified federation. -* :ref:`atlas-api-federatedAuthentication-createRoleMapping` - experimental: Adds one role mapping to the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-deleteFederationApp` - experimental: Deletes the federation settings instance and all associated data, including identity providers and domains. -* :ref:`atlas-api-federatedAuthentication-deleteIdentityProvider` - experimental: Deletes one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-deleteRoleMapping` - experimental: Removes one role mapping in the specified organization from the specified federation. -* :ref:`atlas-api-federatedAuthentication-getConnectedOrgConfig` - experimental: Returns the specified connected org config from the specified federation. -* :ref:`atlas-api-federatedAuthentication-getFederationSettings` - experimental: Returns information about the federation settings for the specified organization. -* :ref:`atlas-api-federatedAuthentication-getIdentityProvider` - experimental: Returns one identity provider in the specified federation by the identity provider's id. -* :ref:`atlas-api-federatedAuthentication-getIdentityProviderMetadata` - experimental: Returns the metadata of one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-getRoleMapping` - experimental: Returns one role mapping from the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listConnectedOrgConfigs` - experimental: Returns all connected org configs in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listIdentityProviders` - experimental: Returns all identity providers with the provided protocol and type in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listRoleMappings` - experimental: Returns all role mappings from the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-removeConnectedOrgConfig` - experimental: Removes one connected organization configuration from the specified federation. -* :ref:`atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider` - experimental: Revokes the JWKS tokens from the requested OIDC identity provider. -* :ref:`atlas-api-federatedAuthentication-updateConnectedOrgConfig` - experimental: Updates one connected organization configuration from the specified federation. -* :ref:`atlas-api-federatedAuthentication-updateIdentityProvider` - experimental: Updates one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-updateRoleMapping` - experimental: Updates one role mapping in the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-createIdentityProvider` - `experimental `: Creates one identity provider within the specified federation. +* :ref:`atlas-api-federatedAuthentication-createRoleMapping` - `experimental `: Adds one role mapping to the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-deleteFederationApp` - `experimental `: Deletes the federation settings instance and all associated data, including identity providers and domains. +* :ref:`atlas-api-federatedAuthentication-deleteIdentityProvider` - `experimental `: Deletes one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-deleteRoleMapping` - `experimental `: Removes one role mapping in the specified organization from the specified federation. +* :ref:`atlas-api-federatedAuthentication-getConnectedOrgConfig` - `experimental `: Returns the specified connected org config from the specified federation. +* :ref:`atlas-api-federatedAuthentication-getFederationSettings` - `experimental `: Returns information about the federation settings for the specified organization. +* :ref:`atlas-api-federatedAuthentication-getIdentityProvider` - `experimental `: Returns one identity provider in the specified federation by the identity provider's id. +* :ref:`atlas-api-federatedAuthentication-getIdentityProviderMetadata` - `experimental `: Returns the metadata of one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-getRoleMapping` - `experimental `: Returns one role mapping from the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listConnectedOrgConfigs` - `experimental `: Returns all connected org configs in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listIdentityProviders` - `experimental `: Returns all identity providers with the provided protocol and type in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listRoleMappings` - `experimental `: Returns all role mappings from the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-removeConnectedOrgConfig` - `experimental `: Removes one connected organization configuration from the specified federation. +* :ref:`atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider` - `experimental `: Revokes the JWKS tokens from the requested OIDC identity provider. +* :ref:`atlas-api-federatedAuthentication-updateConnectedOrgConfig` - `experimental `: Updates one connected organization configuration from the specified federation. +* :ref:`atlas-api-federatedAuthentication-updateIdentityProvider` - `experimental `: Updates one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-updateRoleMapping` - `experimental `: 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 943dd8b253..e3e7e11e02 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 -experimental: Creates one flex cluster in the specified project. +`experimental `: Creates one flex cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createFlexCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster diff --git a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt index 6f2350d913..d1360a2887 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 -experimental: Removes one flex cluster from the specified project. +`experimental `: Removes one flex cluster from the specified project. The flex cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteFlexCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster diff --git a/docs/command/atlas-api-flexClusters-getFlexCluster.txt b/docs/command/atlas-api-flexClusters-getFlexCluster.txt index d2f7030ef9..292171dfda 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 -experimental: Returns details for one flex cluster in the specified project. +`experimental `: Returns details for one flex cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getFlexCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster diff --git a/docs/command/atlas-api-flexClusters-listFlexClusters.txt b/docs/command/atlas-api-flexClusters-listFlexClusters.txt index 61358c523d..38792abbf2 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 -experimental: Returns details for all flex clusters in the specified project. +`experimental `: Returns details for all flex clusters in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listFlexClusters'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters diff --git a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt index b54cda9102..aa62df9193 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 -experimental: Updates one flex cluster in the specified project. +`experimental `: Updates one flex cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateFlexCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateFlexCluster diff --git a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt b/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt index 4100015281..11ac2c5037 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 -experimental: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. +`experimental `: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. This command is invoking the endpoint with OperationID: 'upgradeFlexCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster diff --git a/docs/command/atlas-api-flexClusters.txt b/docs/command/atlas-api-flexClusters.txt index 15194b8538..db977268ba 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 -experimental: Returns, adds, edits, and removes flex clusters. +`experimental `: Returns, adds, edits, and removes flex clusters. Options ------- @@ -49,12 +49,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexClusters-createFlexCluster` - experimental: Creates one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-deleteFlexCluster` - experimental: Removes one flex cluster from the specified project. -* :ref:`atlas-api-flexClusters-getFlexCluster` - experimental: Returns details for one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-listFlexClusters` - experimental: Returns details for all flex clusters in the specified project. -* :ref:`atlas-api-flexClusters-updateFlexCluster` - experimental: Updates one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-upgradeFlexCluster` - experimental: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. +* :ref:`atlas-api-flexClusters-createFlexCluster` - `experimental `: Creates one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-deleteFlexCluster` - `experimental `: Removes one flex cluster from the specified project. +* :ref:`atlas-api-flexClusters-getFlexCluster` - `experimental `: Returns details for one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-listFlexClusters` - `experimental `: Returns details for all flex clusters in the specified project. +* :ref:`atlas-api-flexClusters-updateFlexCluster` - `experimental `: Updates one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-upgradeFlexCluster` - `experimental `: 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 3695cdcd1a..76093edbf9 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 -experimental: Restores one snapshot of one flex cluster from the specified project. +`experimental `: Restores one snapshot of one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createFlexBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob diff --git a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt index 5d98215676..fb97d3bbf9 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 -experimental: Returns one restore job for one flex cluster from the specified project. +`experimental `: Returns one restore job for one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getFlexBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob diff --git a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt index cb8e3e28c2..72130a627e 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 -experimental: Returns all restore jobs for one flex cluster from the specified project. +`experimental `: Returns all restore jobs for one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'listFlexBackupRestoreJobs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs diff --git a/docs/command/atlas-api-flexRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs.txt index c48686273f..37c421692f 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 -experimental: Returns and adds restore jobs for flex database deployments. +`experimental `: Returns and adds restore jobs for flex database deployments. Options ------- @@ -49,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexRestoreJobs-createFlexBackupRestoreJob` - experimental: Restores one snapshot of one flex cluster from the specified project. -* :ref:`atlas-api-flexRestoreJobs-getFlexBackupRestoreJob` - experimental: Returns one restore job for one flex cluster from the specified project. -* :ref:`atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs` - experimental: Returns all restore jobs for one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-createFlexBackupRestoreJob` - `experimental `: Restores one snapshot of one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-getFlexBackupRestoreJob` - `experimental `: Returns one restore job for one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs` - `experimental `: 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 19cee83f42..c5fd27462b 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 -experimental: Requests one snapshot for the specified flex cluster. +`experimental `: Requests one snapshot for the specified flex cluster. This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'downloadFlexBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup diff --git a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt b/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt index 4dedea1c54..b0dac6d332 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 -experimental: Returns one snapshot of one flex cluster from the specified project. +`experimental `: Returns one snapshot of one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getFlexBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup diff --git a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt b/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt index 5703f49777..c6316acc4f 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 -experimental: Returns all snapshots of one flex cluster from the specified project. +`experimental `: Returns all snapshots of one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listFlexBackups'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups diff --git a/docs/command/atlas-api-flexSnapshots.txt b/docs/command/atlas-api-flexSnapshots.txt index 4c7d5f9695..8ffb12c405 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 -experimental: Returns and requests to download flex database deployment snapshots. +`experimental `: Returns and requests to download flex database deployment snapshots. Options ------- @@ -49,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexSnapshots-downloadFlexBackup` - experimental: Requests one snapshot for the specified flex cluster. -* :ref:`atlas-api-flexSnapshots-getFlexBackup` - experimental: Returns one snapshot of one flex cluster from the specified project. -* :ref:`atlas-api-flexSnapshots-listFlexBackups` - experimental: Returns all snapshots of one flex cluster from the specified project. +* :ref:`atlas-api-flexSnapshots-downloadFlexBackup` - `experimental `: Requests one snapshot for the specified flex cluster. +* :ref:`atlas-api-flexSnapshots-getFlexBackup` - `experimental `: Returns one snapshot of one flex cluster from the specified project. +* :ref:`atlas-api-flexSnapshots-listFlexBackups` - `experimental `: 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 7e2a341ef8..936f1befab 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 -experimental: Creates one custom zone mapping for the specified global cluster. +`experimental `: Creates one custom zone mapping for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createCustomZoneMapping'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createCustomZoneMapping diff --git a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt index 27b8408ba5..c3e8d45e6b 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 -experimental: Creates one managed namespace within the specified global cluster. +`experimental `: Creates one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'createManagedNamespace'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createManagedNamespace diff --git a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt b/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt index 483fd7a08a..0a2c8294e2 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 -experimental: Removes all custom zone mappings for the specified global cluster. +`experimental `: Removes all custom zone mappings for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteAllCustomZoneMappings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteAllCustomZoneMappings diff --git a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt b/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt index 5fe50fff3f..38e0949628 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 -experimental: Removes one managed namespace within the specified global cluster. +`experimental `: Removes one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'deleteManagedNamespace'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteManagedNamespace diff --git a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt b/docs/command/atlas-api-globalClusters-getManagedNamespace.txt index 66a44601c5..a47c73c902 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 -experimental: Returns one managed namespace within the specified global cluster. +`experimental `: Returns one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getManagedNamespace'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/getManagedNamespace diff --git a/docs/command/atlas-api-globalClusters.txt b/docs/command/atlas-api-globalClusters.txt index 2473280899..ea99f0d477 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 -experimental: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. +`experimental `: 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. @@ -51,11 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-globalClusters-createCustomZoneMapping` - experimental: Creates one custom zone mapping for the specified global cluster. -* :ref:`atlas-api-globalClusters-createManagedNamespace` - experimental: Creates one managed namespace within the specified global cluster. -* :ref:`atlas-api-globalClusters-deleteAllCustomZoneMappings` - experimental: Removes all custom zone mappings for the specified global cluster. -* :ref:`atlas-api-globalClusters-deleteManagedNamespace` - experimental: Removes one managed namespace within the specified global cluster. -* :ref:`atlas-api-globalClusters-getManagedNamespace` - experimental: Returns one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-createCustomZoneMapping` - `experimental `: Creates one custom zone mapping for the specified global cluster. +* :ref:`atlas-api-globalClusters-createManagedNamespace` - `experimental `: Creates one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-deleteAllCustomZoneMappings` - `experimental `: Removes all custom zone mappings for the specified global cluster. +* :ref:`atlas-api-globalClusters-deleteManagedNamespace` - `experimental `: Removes one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-getManagedNamespace` - `experimental `: 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 0d440e0860..efe6e6b068 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 -experimental: Creates a query process within the Cost Explorer for the given parameters. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'createCostExplorerQueryProcess'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/createCostExplorerQueryProcess diff --git a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt b/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt index d32d7c9bf7..1151119f90 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 -experimental: Returns one invoice that MongoDB issued to the specified organization in CSV format. +`experimental `: Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role. 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. This command is invoking the endpoint with OperationID: 'downloadInvoiceCsv'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/downloadInvoiceCsv diff --git a/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt b/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt index 0d2284b263..1b504baefa 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 -experimental: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'getCostExplorerQueryProcess'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getCostExplorerQueryProcess diff --git a/docs/command/atlas-api-invoices-getInvoice.txt b/docs/command/atlas-api-invoices-getInvoice.txt index a09f2fc6f5..e954096ed5 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 -experimental: Returns one invoice that MongoDB issued to the specified organization. +`experimental `: Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner role. 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. This command is invoking the endpoint with OperationID: 'getInvoice'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getInvoice diff --git a/docs/command/atlas-api-invoices-listInvoices.txt b/docs/command/atlas-api-invoices-listInvoices.txt index d7e7646ac8..fb4d2034ab 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 -experimental: Returns all invoices that MongoDB issued to the specified organization. +`experimental `: Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner role. 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. This command is invoking the endpoint with OperationID: 'listInvoices'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listInvoices diff --git a/docs/command/atlas-api-invoices-listPendingInvoices.txt b/docs/command/atlas-api-invoices-listPendingInvoices.txt index 9b51624d0a..b590e14b0c 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 -experimental: Returns all invoices accruing charges for the current billing cycle for the specified organization. +`experimental `: Returns all invoices accruing charges for the current billing cycle for the specified organization. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. This command is invoking the endpoint with OperationID: 'listPendingInvoices'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listPendingInvoices diff --git a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt b/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt index 7ed4d103b7..d9bb458185 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 -experimental: Query the lineItems of the specified invoice and return the result JSON. +`experimental `: Query the lineItems of the specified invoice and return the result JSON. A unique 24-hexadecimal digit string identifies the invoice. This command is invoking the endpoint with OperationID: 'queryLineItemsFromSingleInvoice'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/queryLineItemsFromSingleInvoice diff --git a/docs/command/atlas-api-invoices.txt b/docs/command/atlas-api-invoices.txt index 36ce597361..7dd3d1988a 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 -experimental: Returns invoices. +`experimental `: Returns invoices. Options ------- @@ -49,13 +49,13 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-invoices-createCostExplorerQueryProcess` - experimental: Creates a query process within the Cost Explorer for the given parameters. -* :ref:`atlas-api-invoices-downloadInvoiceCsv` - experimental: Returns one invoice that MongoDB issued to the specified organization in CSV format. -* :ref:`atlas-api-invoices-getCostExplorerQueryProcess` - experimental: 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` - experimental: Returns one invoice that MongoDB issued to the specified organization. -* :ref:`atlas-api-invoices-listInvoices` - experimental: Returns all invoices that MongoDB issued to the specified organization. -* :ref:`atlas-api-invoices-listPendingInvoices` - experimental: Returns all invoices accruing charges for the current billing cycle for the specified organization. -* :ref:`atlas-api-invoices-queryLineItemsFromSingleInvoice` - experimental: Query the lineItems of the specified invoice and return the result JSON. +* :ref:`atlas-api-invoices-createCostExplorerQueryProcess` - `experimental `: Creates a query process within the Cost Explorer for the given parameters. +* :ref:`atlas-api-invoices-downloadInvoiceCsv` - `experimental `: Returns one invoice that MongoDB issued to the specified organization in CSV format. +* :ref:`atlas-api-invoices-getCostExplorerQueryProcess` - `experimental `: 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` - `experimental `: Returns one invoice that MongoDB issued to the specified organization. +* :ref:`atlas-api-invoices-listInvoices` - `experimental `: Returns all invoices that MongoDB issued to the specified organization. +* :ref:`atlas-api-invoices-listPendingInvoices` - `experimental `: Returns all invoices accruing charges for the current billing cycle for the specified organization. +* :ref:`atlas-api-invoices-queryLineItemsFromSingleInvoice` - `experimental `: 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 4160bf1e59..e07971c7c9 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 -experimental: Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. +`experimental `: Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteLdapConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/deleteLdapConfiguration diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt index f1e4b505dc..7774fcbd8f 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 -experimental: Returns the current LDAP configuration for the specified project. +`experimental `: Returns the current LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getLdapConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfiguration diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt index 1f525e6b00..d15aa2ebba 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 -experimental: Returns the status of one request to verify one LDAP configuration for the specified project. +`experimental `: Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getLdapConfigurationStatus'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfigurationStatus diff --git a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt index 2c2cd2a77a..a3724aa73d 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 -experimental: Edits the LDAP configuration for the specified project. +`experimental `: Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. Updating this configuration triggers a rolling restart of the database. This command is invoking the endpoint with OperationID: 'saveLdapConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/saveLdapConfiguration diff --git a/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt index 2bbfbb7afd..817309cfcf 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 -experimental: Verifies the LDAP configuration for the specified project. +`experimental `: Verifies the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'verifyLdapConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/verifyLdapConfiguration diff --git a/docs/command/atlas-api-ldapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration.txt index 237cd8960f..25b743d623 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 -experimental: Returns, edits, verifies, and removes LDAP configurations. +`experimental `: 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 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-ldapConfiguration-deleteLdapConfiguration` - experimental: 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` - experimental: Returns the current LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-getLdapConfigurationStatus` - experimental: Returns the status of one request to verify one LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-saveLdapConfiguration` - experimental: Edits the LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-verifyLdapConfiguration` - experimental: Verifies the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-deleteLdapConfiguration` - `experimental `: 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` - `experimental `: Returns the current LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-getLdapConfigurationStatus` - `experimental `: Returns the status of one request to verify one LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-saveLdapConfiguration` - `experimental `: Edits the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-verifyLdapConfiguration` - `experimental `: 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 1e863f6592..5be9f6a45d 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 -experimental: Restores one legacy backup for one cluster in the specified project. +`experimental `: Restores one legacy backup for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying delivery.methodName of AUTOMATED_RESTORE in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. This command is invoking the endpoint with OperationID: 'createLegacyBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/createLegacyBackupRestoreJob diff --git a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt index 22c89373c7..520006b5a8 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 -experimental: Removes one legacy backup snapshot for one cluster in the specified project. +`experimental `: Removes one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'deleteLegacySnapshot'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/deleteLegacySnapshot diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt index 18dcce015a..ac72502a09 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 -experimental: Returns one legacy backup checkpoint for one cluster in the specified project. +`experimental `: Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getLegacyBackupCheckpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupCheckpoint diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt index aa8af4bea4..75b42f40a5 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 -experimental: Returns one legacy backup restore job for one cluster in the specified project. +`experimental `: Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'getLegacyBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupRestoreJob diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt index bb1755fe63..d79e85b933 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 -experimental: Returns one legacy backup snapshot for one cluster in the specified project. +`experimental `: Returns one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'getLegacySnapshot'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshot diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt index 5e681df8d5..1e81e18f62 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 -experimental: Returns the snapshot schedule for one cluster in the specified project. +`experimental `: Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'getLegacySnapshotSchedule'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshotSchedule diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt index 7c3f499af0..71d329146a 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 -experimental: Returns all legacy backup checkpoints for one cluster in the specified project. +`experimental `: Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listLegacyBackupCheckpoints'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupCheckpoints diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt index a23cfb0301..f139d9e222 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 -experimental: Returns all legacy backup restore jobs for one cluster in the specified project. +`experimental `: Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. If you use the BATCH-ID query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set. This command is invoking the endpoint with OperationID: 'listLegacyBackupRestoreJobs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupRestoreJobs diff --git a/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt b/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt index e949aee054..16de36aa83 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 -experimental: Returns all legacy backup snapshots for one cluster in the specified project. +`experimental `: Returns all legacy backup snapshots for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'listLegacySnapshots'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacySnapshots diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt index 73c7a430de..d2b26fe047 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 -experimental: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. +`experimental `: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'updateLegacySnapshotRetention'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotRetention diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt index 40e67afff0..ecdf4a69d3 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 -experimental: Updates the snapshot schedule for one cluster in the specified project. +`experimental `: Updates the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'updateLegacySnapshotSchedule'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotSchedule diff --git a/docs/command/atlas-api-legacyBackup.txt b/docs/command/atlas-api-legacyBackup.txt index b68d9fe064..eadfc353b0 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 -experimental: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. +`experimental `: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. Options ------- @@ -49,17 +49,17 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-legacyBackup-createLegacyBackupRestoreJob` - experimental: Restores one legacy backup for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-deleteLegacySnapshot` - experimental: Removes one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacyBackupCheckpoint` - experimental: Returns one legacy backup checkpoint for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacyBackupRestoreJob` - experimental: Returns one legacy backup restore job for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacySnapshot` - experimental: Returns one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacySnapshotSchedule` - experimental: Returns the snapshot schedule for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacyBackupCheckpoints` - experimental: Returns all legacy backup checkpoints for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacyBackupRestoreJobs` - experimental: Returns all legacy backup restore jobs for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacySnapshots` - experimental: Returns all legacy backup snapshots for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-updateLegacySnapshotRetention` - experimental: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-updateLegacySnapshotSchedule` - experimental: Updates the snapshot schedule for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-createLegacyBackupRestoreJob` - `experimental `: Restores one legacy backup for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-deleteLegacySnapshot` - `experimental `: Removes one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacyBackupCheckpoint` - `experimental `: Returns one legacy backup checkpoint for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacyBackupRestoreJob` - `experimental `: Returns one legacy backup restore job for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacySnapshot` - `experimental `: Returns one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacySnapshotSchedule` - `experimental `: Returns the snapshot schedule for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacyBackupCheckpoints` - `experimental `: Returns all legacy backup checkpoints for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacyBackupRestoreJobs` - `experimental `: Returns all legacy backup restore jobs for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacySnapshots` - `experimental `: Returns all legacy backup snapshots for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-updateLegacySnapshotRetention` - `experimental `: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-updateLegacySnapshotSchedule` - `experimental `: 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 e1b9900a34..c79be13174 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 -experimental: Defers the maintenance window for the specified project. +`experimental `: Defers the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deferMaintenanceWindow'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/deferMaintenanceWindow diff --git a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt index 139679b515..860c0909f3 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 -experimental: Returns the maintenance window for the specified project. +`experimental `: Returns the maintenance window for the specified project. MongoDB Cloud starts those maintenance activities when needed. You can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getMaintenanceWindow'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/getMaintenanceWindow diff --git a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt index ecfea43868..0324c25763 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 -experimental: Resets the maintenance window for the specified project. +`experimental `: Resets the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'resetMaintenanceWindow'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/resetMaintenanceWindow diff --git a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt index 9f576c0735..8df7a339b9 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 -experimental: Toggles automatic deferral of the maintenance window for the specified project. +`experimental `: Toggles automatic deferral of the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'toggleMaintenanceAutoDefer'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/toggleMaintenanceAutoDefer diff --git a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt index ed453a3a8c..4eb20605b3 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 -experimental: Updates the maintenance window for the specified project. +`experimental `: Updates the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateMaintenanceWindow'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/updateMaintenanceWindow diff --git a/docs/command/atlas-api-maintenanceWindows.txt b/docs/command/atlas-api-maintenanceWindows.txt index a3260a6265..35c9a3972b 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 -experimental: Returns, edits, and removes maintenance windows. +`experimental `: 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 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-maintenanceWindows-deferMaintenanceWindow` - experimental: Defers the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-getMaintenanceWindow` - experimental: Returns the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-resetMaintenanceWindow` - experimental: Resets the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer` - experimental: Toggles automatic deferral of the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-updateMaintenanceWindow` - experimental: Updates the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-deferMaintenanceWindow` - `experimental `: Defers the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-getMaintenanceWindow` - `experimental `: Returns the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-resetMaintenanceWindow` - `experimental `: Resets the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer` - `experimental `: Toggles automatic deferral of the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-updateMaintenanceWindow` - `experimental `: 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 8e07a06224..22fcfebade 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 -experimental: Adds one organization-level role to the MongoDB Cloud user. +`experimental `: Adds one organization-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role. Note: This operation is atomic. Note: This resource cannot be used to add a role to users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'addOrganizationRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addOrganizationRole diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt index 6c38685a8c..77504bed11 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 -experimental: Adds one project-level role to the MongoDB Cloud user. +`experimental `: 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 API Key must have the Project Owner role. Note: This resource cannot be used to add a role to users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'addProjectRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectRole diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt index b89de7c2af..069f758bde 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 -experimental: Adds one MongoDB Cloud user to one project. +`experimental `: Adds one MongoDB Cloud user to one project. To use this resource, the requesting API Key must have the Group User Admin role. If the user has a pending invitation to join the project's organization, MongoDB Cloud modifies it and grants project access. If the user doesn't have an invitation to join the organization, MongoDB Cloud sends a new invitation that grants the user organization and project access. If the user is already active in the project's organization, MongoDB Cloud grants access to the project. This command is invoking the endpoint with OperationID: 'addProjectUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt b/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt index 0fe410fbea..c8151181ed 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 -experimental: Adds one MongoDB Cloud user to one team. +`experimental `: 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 API Key must have the Organization Owner role. Note: This resource cannot be used to add a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'addUserToTeam'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addUserToTeam diff --git a/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt index 309e8fa871..1fcc2fb75e 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 -experimental: Invites one new or existing MongoDB Cloud user to join the organization. +`experimental `: Invites one new or existing MongoDB Cloud user to join the organization. The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting API Key must have the Organization Owner role. Note: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization. This command is invoking the endpoint with OperationID: 'createOrganizationUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createOrganizationUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt index 2d0cd525f8..ab9709aa0a 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 -experimental: Creates one MongoDB Cloud user account. +`experimental `: Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days. MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization. To use this resource, the requesting API Key can have any role. This command is invoking the endpoint with OperationID: 'createUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt index 1abbdae740..e2c7f8bf91 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 -experimental: Returns information about the specified MongoDB Cloud user within the context of the specified organization. +`experimental `: Returns information about the specified MongoDB Cloud user within the context of the specified organization. To use this resource, the requesting API Key must have the Organization Read Only role. Note: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the Return One Organization API Key endpoint. Note: This resource does not return information about pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'getOrganizationUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getOrganizationUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt index 317396e708..a35688de7e 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 -experimental: Returns information about the specified MongoDB Cloud user within the context of the specified project. +`experimental `: Returns information about the specified MongoDB Cloud user within the context of the specified project. To use this resource, the requesting API Key must have the Group Read Only role. Note: You can only use this resource to fetch information about MongoDB Cloud human users. To return information about an API Key, use the Return One Organization API Key endpoint. Note: This resource does not return information about pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'getProjectUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getProjectUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt index c429feefcf..f64aa499e9 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 -experimental: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. +`experimental `: 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 API Key can have any role. This command is invoking the endpoint with OperationID: 'getUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt index 30ea854e9d..4e5b270210 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 -experimental: Returns the details for one MongoDB Cloud user account with the specified username. +`experimental `: 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 API Key can have any role. This command is invoking the endpoint with OperationID: 'getUserByUsername'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUserByUsername diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt index 0e03a0c65a..0a89516a34 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 -experimental: Removes one organization-level role from the MongoDB Cloud user. +`experimental `: Removes one organization-level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting API Key must have the Organization Owner role. Note: This operation is atomic. Note: This resource cannot be used to remove a role from users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'removeOrganizationRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationRole diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt index 0bcef0b4bd..85c0b6abc6 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 -experimental: Removes one project-level role from the MongoDB Cloud user. +`experimental `: 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 API Key must have the Project Owner role. Note: This resource cannot be used to remove a role from users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'removeProjectRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectRole diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt index ffd2a0f839..8141ed99d6 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 -experimental: Removes one MongoDB Cloud user from one team. +`experimental `: 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 API Key must have the Organization Owner role. Note: This resource cannot be used to remove a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'removeUserFromTeam'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeUserFromTeam diff --git a/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt index 183e7a31e4..5936c69fd8 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 -experimental: Updates one MongoDB Cloud user in the specified organization. +`experimental `: Updates one MongoDB Cloud user in the specified organization. You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role. Note: Only include the fields you wish to update in the request body. Supplying a field with an empty value will reset that field on the user. Note: This resource cannot be used to update pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'updateOrganizationUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrganizationUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers.txt index dc4d1cd0c8..883fe7baf7 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 -experimental: Returns, adds, and edits MongoDB Cloud users. +`experimental `: Returns, adds, and edits MongoDB Cloud users. Options ------- @@ -49,20 +49,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-mongoDbCloudUsers-addOrganizationRole` - experimental: Adds one organization-level role to the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-addProjectRole` - experimental: Adds one project-level role to the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-addProjectUser` - experimental: Adds one MongoDB Cloud user to one project. -* :ref:`atlas-api-mongoDbCloudUsers-addUserToTeam` - experimental: Adds one MongoDB Cloud user to one team. -* :ref:`atlas-api-mongoDbCloudUsers-createOrganizationUser` - experimental: Invites one new or existing MongoDB Cloud user to join the organization. -* :ref:`atlas-api-mongoDbCloudUsers-createUser` - experimental: Creates one MongoDB Cloud user account. -* :ref:`atlas-api-mongoDbCloudUsers-getOrganizationUser` - experimental: Returns information about the specified MongoDB Cloud user within the context of the specified organization. -* :ref:`atlas-api-mongoDbCloudUsers-getProjectUser` - experimental: Returns information about the specified MongoDB Cloud user within the context of the specified project. -* :ref:`atlas-api-mongoDbCloudUsers-getUser` - experimental: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. -* :ref:`atlas-api-mongoDbCloudUsers-getUserByUsername` - experimental: Returns the details for one MongoDB Cloud user account with the specified username. -* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationRole` - experimental: Removes one organization-level role from the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-removeProjectRole` - experimental: Removes one project-level role from the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-removeUserFromTeam` - experimental: Removes one MongoDB Cloud user from one team. -* :ref:`atlas-api-mongoDbCloudUsers-updateOrganizationUser` - experimental: Updates one MongoDB Cloud user in the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-addOrganizationRole` - `experimental `: Adds one organization-level role to the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-addProjectRole` - `experimental `: Adds one project-level role to the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-addProjectUser` - `experimental `: Adds one MongoDB Cloud user to one project. +* :ref:`atlas-api-mongoDbCloudUsers-addUserToTeam` - `experimental `: Adds one MongoDB Cloud user to one team. +* :ref:`atlas-api-mongoDbCloudUsers-createOrganizationUser` - `experimental `: Invites one new or existing MongoDB Cloud user to join the organization. +* :ref:`atlas-api-mongoDbCloudUsers-createUser` - `experimental `: Creates one MongoDB Cloud user account. +* :ref:`atlas-api-mongoDbCloudUsers-getOrganizationUser` - `experimental `: Returns information about the specified MongoDB Cloud user within the context of the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-getProjectUser` - `experimental `: Returns information about the specified MongoDB Cloud user within the context of the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-getUser` - `experimental `: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. +* :ref:`atlas-api-mongoDbCloudUsers-getUserByUsername` - `experimental `: Returns the details for one MongoDB Cloud user account with the specified username. +* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationRole` - `experimental `: Removes one organization-level role from the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-removeProjectRole` - `experimental `: Removes one project-level role from the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-removeUserFromTeam` - `experimental `: Removes one MongoDB Cloud user from one team. +* :ref:`atlas-api-mongoDbCloudUsers-updateOrganizationUser` - `experimental `: 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 041c9975ab..d8cf8c3fbd 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 -experimental: Returns the processes for the specified host for the specified project. +`experimental `: Returns the processes for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getAtlasProcess'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getAtlasProcess diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt index add7c0aba6..eae6d5a365 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 -experimental: Returns one database running on the specified host for the specified project. +`experimental `: Returns one database running on the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getDatabase'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabase diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt index 2a42225f27..33eebc745a 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 -experimental: Returns the measurements of one database for the specified host for the specified project. +`experimental `: Returns the measurements of one database for the specified host for the specified project. Returns the database's on-disk storage space based on the MongoDB dbStats command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getDatabaseMeasurements'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabaseMeasurements diff --git a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt index 1b8652e50f..7a15b4c336 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 -experimental: Returns the measurements of one disk or partition for the specified host for the specified project. +`experimental `: 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 a15cb3dd36..df951e50e0 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 -experimental: Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. +`experimental `: 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 API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". This command is invoking the endpoint with OperationID: 'getHostLogs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostLogs diff --git a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt index db65f848bb..b1e937f017 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 -experimental: Returns disk, partition, or host measurements per process for the specified host for the specified project. +`experimental `: 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 e9b36e4ae9..0b4ffcf8bf 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 -experimental: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'getIndexMetrics'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getIndexMetrics diff --git a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt index 6f16a92cb2..1d422b7732 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 -experimental: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'getMeasurements'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getMeasurements diff --git a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt b/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt index 817715ff41..e89bc5e0fa 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 -experimental: Returns details of all processes for the specified project. +`experimental `: Returns details of all processes for the specified project. A MongoDB process can be either a mongod or mongos. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listAtlasProcesses'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listAtlasProcesses diff --git a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt index 50b4df0193..a74118a17e 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 -experimental: Returns the list of databases running on the specified host for the specified project. +`experimental `: Returns the list of databases running on the specified host for the specified project. M0 free clusters, M2, M5, and serverless clusters have some operational limits. The MongoDB Cloud process must be a mongod. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listDatabases'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDatabases diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt index 19f90d08b1..f52db7a899 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 -experimental: Returns measurement details for one disk or partition for the specified host for the specified project. +`experimental `: Returns measurement details for one disk or partition for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listDiskMeasurements'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskMeasurements diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt index 538547916e..972efb8d28 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 -experimental: Returns the list of disks or partitions for the specified host for the specified project. +`experimental `: Returns the list of disks or partitions for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listDiskPartitions'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskPartitions diff --git a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt b/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt index f879d5b360..fd6d36cdbd 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 -experimental: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. +`experimental `: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. This command is invoking the endpoint with OperationID: 'listIndexMetrics'. For more information about flags, format of --file and examples, see: 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 1147ca926b..3fd705a22d 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 -experimental: Returns all Atlas Search metric types available for one process in the specified project. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'listMetricTypes'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listMetricTypes diff --git a/docs/command/atlas-api-monitoringAndLogs.txt b/docs/command/atlas-api-monitoringAndLogs.txt index 1c478f2a71..d18374086e 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 -experimental: Returns database deployment monitoring and logging data. +`experimental `: Returns database deployment monitoring and logging data. Options ------- @@ -49,20 +49,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-monitoringAndLogs-getAtlasProcess` - experimental: Returns the processes for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDatabase` - experimental: Returns one database running on the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDatabaseMeasurements` - experimental: Returns the measurements of one database for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDiskMeasurements` - experimental: Returns the measurements of one disk or partition for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getHostLogs` - experimental: 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` - experimental: Returns disk, partition, or host measurements per process for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getIndexMetrics` - experimental: 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` - experimental: 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` - experimental: Returns details of all processes for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDatabases` - experimental: Returns the list of databases running on the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDiskMeasurements` - experimental: Returns measurement details for one disk or partition for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDiskPartitions` - experimental: Returns the list of disks or partitions for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listIndexMetrics` - experimental: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. -* :ref:`atlas-api-monitoringAndLogs-listMetricTypes` - experimental: Returns all Atlas Search metric types available for one process in the specified project. +* :ref:`atlas-api-monitoringAndLogs-getAtlasProcess` - `experimental `: Returns the processes for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDatabase` - `experimental `: Returns one database running on the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDatabaseMeasurements` - `experimental `: Returns the measurements of one database for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDiskMeasurements` - `experimental `: Returns the measurements of one disk or partition for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getHostLogs` - `experimental `: 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` - `experimental `: Returns disk, partition, or host measurements per process for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getIndexMetrics` - `experimental `: 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` - `experimental `: 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` - `experimental `: Returns details of all processes for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDatabases` - `experimental `: Returns the list of databases running on the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDiskMeasurements` - `experimental `: Returns measurement details for one disk or partition for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDiskPartitions` - `experimental `: Returns the list of disks or partitions for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listIndexMetrics` - `experimental `: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. +* :ref:`atlas-api-monitoringAndLogs-listMetricTypes` - `experimental `: 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 757db766f0..39a82ce275 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 -experimental: Creates one new network peering connection in the specified project. +`experimental `: Creates one new network peering connection in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. This command is invoking the endpoint with OperationID: 'createPeeringConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringConnection diff --git a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt b/docs/command/atlas-api-networkPeering-createPeeringContainer.txt index 3f098e2863..49d9e88028 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 -experimental: Creates one new network peering container in the specified project. +`experimental `: Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createPeeringContainer'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringContainer diff --git a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt b/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt index ea33252d23..395d5b5bf1 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 -experimental: Removes one network peering connection in the specified project. +`experimental `: Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deletePeeringConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringConnection diff --git a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt b/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt index ac34817b53..235554ddf6 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 -experimental: Removes one network peering container in the specified project. +`experimental `: Removes one network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deletePeeringContainer'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringContainer diff --git a/docs/command/atlas-api-networkPeering-disablePeering.txt b/docs/command/atlas-api-networkPeering-disablePeering.txt index 14ec7b5a86..f51872df02 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 -experimental: Disables Connect via Peering Only mode for the specified project. +`experimental `: Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'disablePeering'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/disablePeering diff --git a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt b/docs/command/atlas-api-networkPeering-getPeeringConnection.txt index 1d4d67bdf7..29bc2ae999 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 -experimental: Returns details about one specified network peering connection in the specified project. +`experimental `: Returns details about one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPeeringConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringConnection diff --git a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt b/docs/command/atlas-api-networkPeering-getPeeringContainer.txt index f9f7934e92..0fc49f2d62 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 -experimental: Returns details about one network peering container in one specified project. +`experimental `: Returns details about one network peering container in one specified project. Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPeeringContainer'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringContainer diff --git a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt b/docs/command/atlas-api-networkPeering-listPeeringConnections.txt index 9bdcb4dcb4..fe9af28d0a 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 -experimental: Returns details about all network peering connections in the specified project. +`experimental `: Returns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPeeringConnections'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringConnections diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt b/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt index 2217a1bb78..d03bc578fd 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 -experimental: Returns details about all network peering containers in the specified project for the specified cloud provider. +`experimental `: Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPeeringContainerByCloudProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainerByCloudProvider diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt b/docs/command/atlas-api-networkPeering-listPeeringContainers.txt index 45da85e3a9..10436e1ac8 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 -experimental: Returns details about all network peering containers in the specified project. +`experimental `: Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPeeringContainers'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainers diff --git a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt b/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt index 709fc8d303..6db31ce7f8 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 -experimental: Updates one specified network peering connection in the specified project. +`experimental `: Updates one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updatePeeringConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringConnection diff --git a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt b/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt index 6dde0dfdac..9a556011db 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 -experimental: Updates the network details and labels of one specified network peering container in the specified project. +`experimental `: Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updatePeeringContainer'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringContainer diff --git a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt b/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt index f57be00249..3f2b26b384 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 -experimental: Verifies if someone set the specified project to Connect via Peering Only mode. +`experimental `: Verifies if someone set the specified project to Connect via Peering Only mode. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'verifyConnectViaPeeringOnlyModeForOneProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/verifyConnectViaPeeringOnlyModeForOneProject diff --git a/docs/command/atlas-api-networkPeering.txt b/docs/command/atlas-api-networkPeering.txt index 7863afa279..c39729d6b1 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 -experimental: Returns, adds, edits, and removes network peering containers and peering connections. +`experimental `: 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 +51,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-networkPeering-createPeeringConnection` - experimental: Creates one new network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-createPeeringContainer` - experimental: Creates one new network peering container in the specified project. -* :ref:`atlas-api-networkPeering-deletePeeringConnection` - experimental: Removes one network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-deletePeeringContainer` - experimental: Removes one network peering container in the specified project. -* :ref:`atlas-api-networkPeering-disablePeering` - experimental: Disables Connect via Peering Only mode for the specified project. -* :ref:`atlas-api-networkPeering-getPeeringConnection` - experimental: Returns details about one specified network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-getPeeringContainer` - experimental: Returns details about one network peering container in one specified project. -* :ref:`atlas-api-networkPeering-listPeeringConnections` - experimental: Returns details about all network peering connections in the specified project. -* :ref:`atlas-api-networkPeering-listPeeringContainerByCloudProvider` - experimental: Returns details about all network peering containers in the specified project for the specified cloud provider. -* :ref:`atlas-api-networkPeering-listPeeringContainers` - experimental: Returns details about all network peering containers in the specified project. -* :ref:`atlas-api-networkPeering-updatePeeringConnection` - experimental: Updates one specified network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-updatePeeringContainer` - experimental: Updates the network details and labels of one specified network peering container in the specified project. -* :ref:`atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject` - experimental: Verifies if someone set the specified project to Connect via Peering Only mode. +* :ref:`atlas-api-networkPeering-createPeeringConnection` - `experimental `: Creates one new network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-createPeeringContainer` - `experimental `: Creates one new network peering container in the specified project. +* :ref:`atlas-api-networkPeering-deletePeeringConnection` - `experimental `: Removes one network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-deletePeeringContainer` - `experimental `: Removes one network peering container in the specified project. +* :ref:`atlas-api-networkPeering-disablePeering` - `experimental `: Disables Connect via Peering Only mode for the specified project. +* :ref:`atlas-api-networkPeering-getPeeringConnection` - `experimental `: Returns details about one specified network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-getPeeringContainer` - `experimental `: Returns details about one network peering container in one specified project. +* :ref:`atlas-api-networkPeering-listPeeringConnections` - `experimental `: Returns details about all network peering connections in the specified project. +* :ref:`atlas-api-networkPeering-listPeeringContainerByCloudProvider` - `experimental `: Returns details about all network peering containers in the specified project for the specified cloud provider. +* :ref:`atlas-api-networkPeering-listPeeringContainers` - `experimental `: Returns details about all network peering containers in the specified project. +* :ref:`atlas-api-networkPeering-updatePeeringConnection` - `experimental `: Updates one specified network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-updatePeeringContainer` - `experimental `: Updates the network details and labels of one specified network peering container in the specified project. +* :ref:`atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject` - `experimental `: 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 d6974ec15d..39d3988e99 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 -experimental: Creates one online archive. +`experimental `: Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'createOnlineArchive'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/createOnlineArchive diff --git a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt index 0d3e801705..18cce1776a 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 -experimental: Removes one online archive. +`experimental `: Removes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'deleteOnlineArchive'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/deleteOnlineArchive diff --git a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt b/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt index 52fcc1a2df..9b9206da75 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 -experimental: Downloads query logs for the specified online archive. +`experimental `: Downloads query logs for the specified online archive. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". This command is invoking the endpoint with OperationID: 'downloadOnlineArchiveQueryLogs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadOnlineArchiveQueryLogs diff --git a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt index 4c2bacf3f5..b984e38a8a 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 -experimental: Returns one online archive for one cluster. +`experimental `: Returns one online archive for one cluster. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getOnlineArchive'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/getOnlineArchive diff --git a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt index 4ea545f93a..19f9986353 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 -experimental: Returns details of all online archives. +`experimental `: Returns details of all online archives. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listOnlineArchives'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/listOnlineArchives diff --git a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt index 45b489dea9..8b1449d9da 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 -experimental: Updates, pauses, or resumes one online archive. +`experimental `: Updates, pauses, or resumes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'updateOnlineArchive'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/updateOnlineArchive diff --git a/docs/command/atlas-api-onlineArchive.txt b/docs/command/atlas-api-onlineArchive.txt index aeb8f6c9d4..f93de7ecba 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 -experimental: Returns, adds, edits, or removes an online archive. +`experimental `: Returns, adds, edits, or removes an online archive. Options ------- @@ -49,12 +49,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-onlineArchive-createOnlineArchive` - experimental: Creates one online archive. -* :ref:`atlas-api-onlineArchive-deleteOnlineArchive` - experimental: Removes one online archive. -* :ref:`atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs` - experimental: Downloads query logs for the specified online archive. -* :ref:`atlas-api-onlineArchive-getOnlineArchive` - experimental: Returns one online archive for one cluster. -* :ref:`atlas-api-onlineArchive-listOnlineArchives` - experimental: Returns details of all online archives. -* :ref:`atlas-api-onlineArchive-updateOnlineArchive` - experimental: Updates, pauses, or resumes one online archive. +* :ref:`atlas-api-onlineArchive-createOnlineArchive` - `experimental `: Creates one online archive. +* :ref:`atlas-api-onlineArchive-deleteOnlineArchive` - `experimental `: Removes one online archive. +* :ref:`atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs` - `experimental `: Downloads query logs for the specified online archive. +* :ref:`atlas-api-onlineArchive-getOnlineArchive` - `experimental `: Returns one online archive for one cluster. +* :ref:`atlas-api-onlineArchive-listOnlineArchives` - `experimental `: Returns details of all online archives. +* :ref:`atlas-api-onlineArchive-updateOnlineArchive` - `experimental `: Updates, pauses, or resumes one online archive. .. toctree:: diff --git a/docs/command/atlas-api-openApi-getApiVersions.txt b/docs/command/atlas-api-openApi-getApiVersions.txt index 88614cee07..3db0909fe1 100644 --- a/docs/command/atlas-api-openApi-getApiVersions.txt +++ b/docs/command/atlas-api-openApi-getApiVersions.txt @@ -12,7 +12,7 @@ atlas api openApi getApiVersions :depth: 1 :class: singlecol -experimental: API that provides a list of available versionsfor a given environment. +`experimental `: API that provides a list of available versionsfor a given environment. This command is invoking the endpoint with OperationID: 'getApiVersions'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/OpenAPI/operation/getApiVersions diff --git a/docs/command/atlas-api-openApi-getOpenApiInfo.txt b/docs/command/atlas-api-openApi-getOpenApiInfo.txt index a7ebb4810d..323b872211 100644 --- a/docs/command/atlas-api-openApi-getOpenApiInfo.txt +++ b/docs/command/atlas-api-openApi-getOpenApiInfo.txt @@ -12,7 +12,7 @@ atlas api openApi getOpenApiInfo :depth: 1 :class: singlecol -experimental: This resource returns general information about the MongoDB Atlas Administration API OpenAPI Specification. +`experimental `: This resource returns general information about the MongoDB Atlas Administration API OpenAPI Specification. This command is invoking the endpoint with OperationID: 'getOpenApiInfo'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/OpenAPI/operation/getOpenApiInfo diff --git a/docs/command/atlas-api-openApi.txt b/docs/command/atlas-api-openApi.txt index 8cf5487abd..9619b50f9c 100644 --- a/docs/command/atlas-api-openApi.txt +++ b/docs/command/atlas-api-openApi.txt @@ -12,7 +12,7 @@ atlas api openApi :depth: 1 :class: singlecol -experimental: Returns information about the MongoDB Atlas Specification. +`experimental `: Returns information about the MongoDB Atlas Specification. Options ------- @@ -49,8 +49,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-openApi-getApiVersions` - experimental: API that provides a list of available versionsfor a given environment. -* :ref:`atlas-api-openApi-getOpenApiInfo` - experimental: This resource returns general information about the MongoDB Atlas Administration API OpenAPI Specification. +* :ref:`atlas-api-openApi-getApiVersions` - `experimental `: API that provides a list of available versionsfor a given environment. +* :ref:`atlas-api-openApi-getOpenApiInfo` - `experimental `: This resource returns general information about the MongoDB Atlas Administration API OpenAPI Specification. .. toctree:: diff --git a/docs/command/atlas-api-organizations-createOrganization.txt b/docs/command/atlas-api-organizations-createOrganization.txt index 5e93c0f606..0359fe3d97 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 -experimental: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. +`experimental `: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. To use this resource, the requesting API Key must have the Organization Owner role. The requesting API Key's organization must be a paying organization. To learn more, see Configure a Paying Organization in the MongoDB Atlas documentation. This command is invoking the endpoint with OperationID: 'createOrganization'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganization diff --git a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt b/docs/command/atlas-api-organizations-createOrganizationInvitation.txt index 3df89c2ae9..9bf799b4e0 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 -experimental: Invites one MongoDB Cloud user to join the specified organization. +`experimental `: Invites one MongoDB Cloud user to join the specified organization. The user must accept the invitation to access information within the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'createOrganizationInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganizationInvitation diff --git a/docs/command/atlas-api-organizations-deleteOrganization.txt b/docs/command/atlas-api-organizations-deleteOrganization.txt index c302a568c6..9eb19914c9 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 -experimental: Removes one specified organization. +`experimental `: 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 a1b1bb4b47..bda545615c 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 -experimental: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. +`experimental `: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'deleteOrganizationInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganizationInvitation diff --git a/docs/command/atlas-api-organizations-getOrganization.txt b/docs/command/atlas-api-organizations-getOrganization.txt index 45c4a7607b..e3a033eb0a 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 -experimental: Returns one organization to which the requesting API key has access. +`experimental `: Returns one organization to which the requesting API key has access. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'getOrganization'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganization diff --git a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt b/docs/command/atlas-api-organizations-getOrganizationInvitation.txt index 0df71cb59c..f3fcb2e20f 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 -experimental: Returns the details of one pending invitation to the specified organization. +`experimental `: Returns the details of one pending invitation to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'getOrganizationInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationInvitation diff --git a/docs/command/atlas-api-organizations-getOrganizationSettings.txt b/docs/command/atlas-api-organizations-getOrganizationSettings.txt index 326ab821e7..593356a880 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 -experimental: Returns details about the specified organization's settings. +`experimental `: Returns details about the specified organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'getOrganizationSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationSettings diff --git a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt index 3c3664ddea..d4480e9340 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 -experimental: Returns all pending invitations to the specified organization. +`experimental `: Returns all pending invitations to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'listOrganizationInvitations'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationInvitations diff --git a/docs/command/atlas-api-organizations-listOrganizationProjects.txt b/docs/command/atlas-api-organizations-listOrganizationProjects.txt index 4065d1bd22..c58d5a919c 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 -experimental: Returns multiple projects in the specified organization. +`experimental `: Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to: diff --git a/docs/command/atlas-api-organizations-listOrganizationUsers.txt b/docs/command/atlas-api-organizations-listOrganizationUsers.txt index 4f36286eb7..5ec9ec75c7 100644 --- a/docs/command/atlas-api-organizations-listOrganizationUsers.txt +++ b/docs/command/atlas-api-organizations-listOrganizationUsers.txt @@ -12,7 +12,7 @@ atlas api organizations listOrganizationUsers :depth: 1 :class: singlecol -experimental: Returns details about the MongoDB Cloud users associated with the specified organization. +`experimental `: Returns details about the MongoDB Cloud users associated with the specified organization. Each MongoDB Cloud user returned must belong to the specified organization or to a project within the specified organization. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listOrganizationUsers'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationUsers diff --git a/docs/command/atlas-api-organizations-listOrganizations.txt b/docs/command/atlas-api-organizations-listOrganizations.txt index e27db6f8b3..d4b3cb16d7 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 -experimental: Returns all organizations to which the requesting API Key has access. +`experimental `: Returns all organizations to which the requesting API Key has access. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listOrganizations'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizations diff --git a/docs/command/atlas-api-organizations-removeOrganizationUser.txt b/docs/command/atlas-api-organizations-removeOrganizationUser.txt index b92c2bfdce..a2b71de1ff 100644 --- a/docs/command/atlas-api-organizations-removeOrganizationUser.txt +++ b/docs/command/atlas-api-organizations-removeOrganizationUser.txt @@ -12,7 +12,7 @@ atlas api organizations removeOrganizationUser :depth: 1 :class: singlecol -experimental: Removes one MongoDB Cloud user from the specified organization. +`experimental `: Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. This command is invoking the endpoint with OperationID: 'removeOrganizationUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/removeOrganizationUser diff --git a/docs/command/atlas-api-organizations-updateOrganization.txt b/docs/command/atlas-api-organizations-updateOrganization.txt index f91b72e580..21243a5f58 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 -experimental: Updates one organization. +`experimental `: Updates one organization. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'updateOrganization'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganization diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt index 06cf1dd11d..95fe89008b 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 -experimental: Updates the details of one pending invitation to the specified organization. +`experimental `: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the username of the invited user. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'updateOrganizationInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitation diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt index 2408fc81fb..e4fc04d9e7 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 -experimental: Updates the details of one pending invitation to the specified organization. +`experimental `: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the unique identification string for that invitation. Use the Return All Organization Invitations endpoint to retrieve IDs for all pending organization invitations. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'updateOrganizationInvitationById'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitationById diff --git a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt b/docs/command/atlas-api-organizations-updateOrganizationRoles.txt index 9cfa0071a0..0ccdf8535f 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 -experimental: Updates the roles of the specified user in the specified organization. +`experimental `: Updates the roles of the specified user in the specified organization. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. This command is invoking the endpoint with OperationID: 'updateOrganizationRoles'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationRoles diff --git a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt b/docs/command/atlas-api-organizations-updateOrganizationSettings.txt index 795a8a4e34..fd27a68103 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 -experimental: Updates the organization's settings. +`experimental `: Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'updateOrganizationSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationSettings diff --git a/docs/command/atlas-api-organizations.txt b/docs/command/atlas-api-organizations.txt index 2135b5a4e3..1919c148b1 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 -experimental: Returns, adds, and edits organizational units in MongoDB Cloud. +`experimental `: Returns, adds, and edits organizational units in MongoDB Cloud. Options ------- @@ -49,23 +49,23 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-organizations-createOrganization` - experimental: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. -* :ref:`atlas-api-organizations-createOrganizationInvitation` - experimental: Invites one MongoDB Cloud user to join the specified organization. -* :ref:`atlas-api-organizations-deleteOrganization` - experimental: Removes one specified organization. -* :ref:`atlas-api-organizations-deleteOrganizationInvitation` - experimental: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. -* :ref:`atlas-api-organizations-getOrganization` - experimental: Returns one organization to which the requesting API key has access. -* :ref:`atlas-api-organizations-getOrganizationInvitation` - experimental: Returns the details of one pending invitation to the specified organization. -* :ref:`atlas-api-organizations-getOrganizationSettings` - experimental: Returns details about the specified organization's settings. -* :ref:`atlas-api-organizations-listOrganizationInvitations` - experimental: Returns all pending invitations to the specified organization. -* :ref:`atlas-api-organizations-listOrganizationProjects` - experimental: Returns multiple projects in the specified organization. -* :ref:`atlas-api-organizations-listOrganizationUsers` - experimental: Returns details about the MongoDB Cloud users associated with the specified organization. -* :ref:`atlas-api-organizations-listOrganizations` - experimental: Returns all organizations to which the requesting API Key has access. -* :ref:`atlas-api-organizations-removeOrganizationUser` - experimental: Removes one MongoDB Cloud user from the specified organization. -* :ref:`atlas-api-organizations-updateOrganization` - experimental: Updates one organization. -* :ref:`atlas-api-organizations-updateOrganizationInvitation` - experimental: Updates the details of one pending invitation to the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationInvitationById` - experimental: Updates the details of one pending invitation to the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationRoles` - experimental: Updates the roles of the specified user in the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationSettings` - experimental: Updates the organization's settings. +* :ref:`atlas-api-organizations-createOrganization` - `experimental `: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. +* :ref:`atlas-api-organizations-createOrganizationInvitation` - `experimental `: Invites one MongoDB Cloud user to join the specified organization. +* :ref:`atlas-api-organizations-deleteOrganization` - `experimental `: Removes one specified organization. +* :ref:`atlas-api-organizations-deleteOrganizationInvitation` - `experimental `: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. +* :ref:`atlas-api-organizations-getOrganization` - `experimental `: Returns one organization to which the requesting API key has access. +* :ref:`atlas-api-organizations-getOrganizationInvitation` - `experimental `: Returns the details of one pending invitation to the specified organization. +* :ref:`atlas-api-organizations-getOrganizationSettings` - `experimental `: Returns details about the specified organization's settings. +* :ref:`atlas-api-organizations-listOrganizationInvitations` - `experimental `: Returns all pending invitations to the specified organization. +* :ref:`atlas-api-organizations-listOrganizationProjects` - `experimental `: Returns multiple projects in the specified organization. +* :ref:`atlas-api-organizations-listOrganizationUsers` - `experimental `: Returns details about the MongoDB Cloud users associated with the specified organization. +* :ref:`atlas-api-organizations-listOrganizations` - `experimental `: Returns all organizations to which the requesting API Key has access. +* :ref:`atlas-api-organizations-removeOrganizationUser` - `experimental `: Removes one MongoDB Cloud user from the specified organization. +* :ref:`atlas-api-organizations-updateOrganization` - `experimental `: Updates one organization. +* :ref:`atlas-api-organizations-updateOrganizationInvitation` - `experimental `: Updates the details of one pending invitation to the specified organization. +* :ref:`atlas-api-organizations-updateOrganizationInvitationById` - `experimental `: Updates the details of one pending invitation to the specified organization. +* :ref:`atlas-api-organizations-updateOrganizationRoles` - `experimental `: Updates the roles of the specified user in the specified organization. +* :ref:`atlas-api-organizations-updateOrganizationSettings` - `experimental `: 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 406307dcd8..7cbdb8b8e8 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 -experimental: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. +`experimental `: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'disableSlowOperationThresholding'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/disableSlowOperationThresholding diff --git a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt b/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt index e1a364b851..262dfe4a91 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 -experimental: Enables MongoDB Cloud to use its slow operation threshold for the specified project. +`experimental `: Enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'enableSlowOperationThresholding'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/enableSlowOperationThresholding diff --git a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt index 88822b1037..f57e7d1a85 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 -experimental: Get whether the Managed Slow MS feature is enabled. +`experimental `: Get whether the Managed Slow MS feature is enabled. This command is invoking the endpoint with OperationID: 'getManagedSlowMs'. For more information about flags, format of --file and examples, see: 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 9fe266c91e..61c6b2c99b 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 -experimental: Get whether the Serverless Auto Indexing feature is enabled. +`experimental `: Get whether the Serverless Auto Indexing feature is enabled. This command is invoking the endpoint with OperationID: 'getServerlessAutoIndexing'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getServerlessAutoIndexing diff --git a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt index 69e8c7d05d..342c1654bd 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 -experimental: Returns the indexes that the Performance Advisor suggests. +`experimental `: Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listClusterSuggestedIndexes'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listClusterSuggestedIndexes diff --git a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt index 7aa5c877e9..86bd3876f3 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 -experimental: Returns the indexes that the Performance Advisor suggests to drop. +`experimental `: 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 API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listDropIndexes'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listDropIndexes diff --git a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt index 44ce7f9486..c1917cce14 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 -experimental: Returns the schema suggestions that the Performance Advisor detects. +`experimental `: 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 API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listSchemaAdvice'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSchemaAdvice diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt index 059a8f4865..bba001922a 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 -experimental: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. +`experimental `: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'listSlowQueries'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueries diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt index dde75f1661..d2004ea5eb 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 -experimental: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. +`experimental `: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listSlowQueryNamespaces'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueryNamespaces diff --git a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt index 7fafc12944..c297a6650f 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 -experimental: Returns the indexes that the Performance Advisor suggests. +`experimental `: Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listSuggestedIndexes'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSuggestedIndexes diff --git a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt index 7ed42fd467..82ae8791e8 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 -experimental: Set whether the Serverless Auto Indexing feature is enabled. +`experimental `: Set whether the Serverless Auto Indexing feature is enabled. This command is invoking the endpoint with OperationID: 'setServerlessAutoIndexing'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/setServerlessAutoIndexing diff --git a/docs/command/atlas-api-performanceAdvisor.txt b/docs/command/atlas-api-performanceAdvisor.txt index ecc2cf9216..d27498c966 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 -experimental: Returns suggested indexes and slow query data for a database deployment. +`experimental `: 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 +51,17 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-performanceAdvisor-disableSlowOperationThresholding` - experimental: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. -* :ref:`atlas-api-performanceAdvisor-enableSlowOperationThresholding` - experimental: Enables MongoDB Cloud to use its slow operation threshold for the specified project. -* :ref:`atlas-api-performanceAdvisor-getManagedSlowMs` - experimental: Get whether the Managed Slow MS feature is enabled. -* :ref:`atlas-api-performanceAdvisor-getServerlessAutoIndexing` - experimental: Get whether the Serverless Auto Indexing feature is enabled. -* :ref:`atlas-api-performanceAdvisor-listClusterSuggestedIndexes` - experimental: Returns the indexes that the Performance Advisor suggests. -* :ref:`atlas-api-performanceAdvisor-listDropIndexes` - experimental: Returns the indexes that the Performance Advisor suggests to drop. -* :ref:`atlas-api-performanceAdvisor-listSchemaAdvice` - experimental: Returns the schema suggestions that the Performance Advisor detects. -* :ref:`atlas-api-performanceAdvisor-listSlowQueries` - experimental: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. -* :ref:`atlas-api-performanceAdvisor-listSlowQueryNamespaces` - experimental: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. -* :ref:`atlas-api-performanceAdvisor-listSuggestedIndexes` - experimental: Returns the indexes that the Performance Advisor suggests. -* :ref:`atlas-api-performanceAdvisor-setServerlessAutoIndexing` - experimental: Set whether the Serverless Auto Indexing feature is enabled. +* :ref:`atlas-api-performanceAdvisor-disableSlowOperationThresholding` - `experimental `: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. +* :ref:`atlas-api-performanceAdvisor-enableSlowOperationThresholding` - `experimental `: Enables MongoDB Cloud to use its slow operation threshold for the specified project. +* :ref:`atlas-api-performanceAdvisor-getManagedSlowMs` - `experimental `: Get whether the Managed Slow MS feature is enabled. +* :ref:`atlas-api-performanceAdvisor-getServerlessAutoIndexing` - `experimental `: Get whether the Serverless Auto Indexing feature is enabled. +* :ref:`atlas-api-performanceAdvisor-listClusterSuggestedIndexes` - `experimental `: Returns the indexes that the Performance Advisor suggests. +* :ref:`atlas-api-performanceAdvisor-listDropIndexes` - `experimental `: Returns the indexes that the Performance Advisor suggests to drop. +* :ref:`atlas-api-performanceAdvisor-listSchemaAdvice` - `experimental `: Returns the schema suggestions that the Performance Advisor detects. +* :ref:`atlas-api-performanceAdvisor-listSlowQueries` - `experimental `: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. +* :ref:`atlas-api-performanceAdvisor-listSlowQueryNamespaces` - `experimental `: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. +* :ref:`atlas-api-performanceAdvisor-listSuggestedIndexes` - `experimental `: Returns the indexes that the Performance Advisor suggests. +* :ref:`atlas-api-performanceAdvisor-setServerlessAutoIndexing` - `experimental `: 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 32b735bb34..258244ff48 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 -experimental: Creates one private endpoint for the specified cloud service provider. +`experimental `: Creates one private endpoint for the specified cloud service provider. This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. This command is invoking the endpoint with OperationID: 'createPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpoint diff --git a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt index 4d659d57fe..b4f19d67be 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 -experimental: Creates one private endpoint service for the specified cloud service provider. +`experimental `: Creates one private endpoint service for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createPrivateEndpointService'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpointService diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt index b4de5c21a1..733ff14392 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 -experimental: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. +`experimental `: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deletePrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpoint diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt index 91ebcc1cdc..0c33eff02f 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 -experimental: Removes one private endpoint service from the specified project. +`experimental `: Removes one private endpoint service from the specified project. This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deletePrivateEndpointService'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpointService diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt index 16eae5f9ed..7bfd9f4fe7 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 -experimental: Returns the connection state of the specified private endpoint. +`experimental `: Returns the connection state of the specified private endpoint. The private endpoint service manages this private endpoint which belongs to one project hosted from one cloud service provider. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpoint diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt index 9d7fa21e65..d7b67282b5 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 -experimental: Returns the name, interfaces, and state of the specified private endpoint service from one project. +`experimental `: Returns the name, interfaces, and state of the specified private endpoint service from one project. The cloud service provider hosted this private endpoint service that belongs to the project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPrivateEndpointService'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpointService diff --git a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt index cd03e79b60..c2d9aab449 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 -experimental: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. +`experimental `: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. The cloud service provider manages the private endpoint for the project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getRegionalizedPrivateEndpointSetting'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getRegionalizedPrivateEndpointSetting diff --git a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt index 14d70d502a..9a8e9e4c8c 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 -experimental: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. +`experimental `: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPrivateEndpointServices'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/listPrivateEndpointServices diff --git a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt index c7426eb27c..6425a14a3c 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 -experimental: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. +`experimental `: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. The cloud service provider manages the private endpoints for the project. Connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime. To use this resource, the requesting API Key must have the Project Owner role and all clusters in the deployment must be sharded clusters. Once enabled, you cannot create replica sets. This command is invoking the endpoint with OperationID: 'toggleRegionalizedPrivateEndpointSetting'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/toggleRegionalizedPrivateEndpointSetting diff --git a/docs/command/atlas-api-privateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices.txt index 62edac847f..a1431b50bc 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 -experimental: Returns, adds, edits, and removes private endpoint services. +`experimental `: Returns, adds, edits, and removes private endpoint services. Options ------- @@ -49,15 +49,15 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-privateEndpointServices-createPrivateEndpoint` - experimental: Creates one private endpoint for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-createPrivateEndpointService` - experimental: Creates one private endpoint service for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpoint` - experimental: 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` - experimental: Removes one private endpoint service from the specified project. -* :ref:`atlas-api-privateEndpointServices-getPrivateEndpoint` - experimental: Returns the connection state of the specified private endpoint. -* :ref:`atlas-api-privateEndpointServices-getPrivateEndpointService` - experimental: Returns the name, interfaces, and state of the specified private endpoint service from one project. -* :ref:`atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting` - experimental: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. -* :ref:`atlas-api-privateEndpointServices-listPrivateEndpointServices` - experimental: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting` - experimental: 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` - `experimental `: Creates one private endpoint for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-createPrivateEndpointService` - `experimental `: Creates one private endpoint service for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpoint` - `experimental `: 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` - `experimental `: Removes one private endpoint service from the specified project. +* :ref:`atlas-api-privateEndpointServices-getPrivateEndpoint` - `experimental `: Returns the connection state of the specified private endpoint. +* :ref:`atlas-api-privateEndpointServices-getPrivateEndpointService` - `experimental `: Returns the name, interfaces, and state of the specified private endpoint service from one project. +* :ref:`atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting` - `experimental `: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. +* :ref:`atlas-api-privateEndpointServices-listPrivateEndpointServices` - `experimental `: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting` - `experimental `: 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 35b66e0065..29e8e00bbe 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 -experimental: Assigns the specified organization API key to the specified project. +`experimental `: Assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'addProjectApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addProjectApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt index 5eb0d5b2e0..6015b9a454 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 -experimental: Creates one API key for the specified organization. +`experimental `: Creates one API key for the specified organization. An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'createApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt index 7ce415994d..76a96c9ef4 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 -experimental: Creates the access list entries for the specified organization API key. +`experimental `: Creates the access list entries for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role. This command is invoking the endpoint with OperationID: 'createApiKeyAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKeyAccessList diff --git a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt index d47228e994..142acba04d 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 -experimental: Creates and assigns the specified organization API key to the specified project. +`experimental `: Creates and assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createProjectApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt index 2e006f0c62..8c5e8d2fe8 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 -experimental: Removes one organization API key from the specified organization. +`experimental `: Removes one organization API key from the specified organization. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'deleteApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt index 9ed426d1aa..984dc55dd1 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 -experimental: Removes the specified access list entry from the specified organization API key. +`experimental `: Removes the specified access list entry from the specified organization API key. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. This command is invoking the endpoint with OperationID: 'deleteApiKeyAccessListEntry'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKeyAccessListEntry diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt index cbf4fdc6f8..4412f4535d 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 -experimental: Returns one organization API key. +`experimental `: Returns one organization API key. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'getApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt index fb20d992e9..07fc107543 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 -experimental: Returns one access list entry for the specified organization API key. +`experimental `: Returns one access list entry for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'getApiKeyAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKeyAccessList diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt index 9fb4de209f..a18b417a58 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 -experimental: Returns all access list entries that you configured for the specified organization API key. +`experimental `: Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listApiKeyAccessListsEntries'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeyAccessListsEntries diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt index beb1c67976..b1ee3a9a00 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 -experimental: Returns all organization API keys for the specified organization. +`experimental `: Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listApiKeys'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeys diff --git a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt index fb36e4dd37..e26006afb4 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 -experimental: Returns all organization API keys that you assigned to the specified project. +`experimental `: Returns all organization API keys that you assigned to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'listProjectApiKeys'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listProjectApiKeys diff --git a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt index e71fa8932f..a9c2520cb8 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 -experimental: Removes one organization API key from the specified project. +`experimental `: Removes one organization API key from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'removeProjectApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/removeProjectApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt index 3bbe30acef..93f337be8d 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 -experimental: Updates one organization API key in the specified organization. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'updateApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt index 683c0eea87..21c27ec759 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 -experimental: Updates the roles of the organization API key that you specify for the project that you specify. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'updateApiKeyRoles'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKeyRoles diff --git a/docs/command/atlas-api-programmaticApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys.txt index 553e440d9d..2710711ee1 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 -experimental: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. +`experimental `: 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 +51,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-programmaticApiKeys-addProjectApiKey` - experimental: Assigns the specified organization API key to the specified project. -* :ref:`atlas-api-programmaticApiKeys-createApiKey` - experimental: Creates one API key for the specified organization. -* :ref:`atlas-api-programmaticApiKeys-createApiKeyAccessList` - experimental: Creates the access list entries for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-createProjectApiKey` - experimental: Creates and assigns the specified organization API key to the specified project. -* :ref:`atlas-api-programmaticApiKeys-deleteApiKey` - experimental: Removes one organization API key from the specified organization. -* :ref:`atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry` - experimental: Removes the specified access list entry from the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-getApiKey` - experimental: Returns one organization API key. -* :ref:`atlas-api-programmaticApiKeys-getApiKeyAccessList` - experimental: Returns one access list entry for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries` - experimental: Returns all access list entries that you configured for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-listApiKeys` - experimental: Returns all organization API keys for the specified organization. -* :ref:`atlas-api-programmaticApiKeys-listProjectApiKeys` - experimental: Returns all organization API keys that you assigned to the specified project. -* :ref:`atlas-api-programmaticApiKeys-removeProjectApiKey` - experimental: Removes one organization API key from the specified project. -* :ref:`atlas-api-programmaticApiKeys-updateApiKey` - experimental: Updates one organization API key in the specified organization. -* :ref:`atlas-api-programmaticApiKeys-updateApiKeyRoles` - experimental: Updates the roles of the organization API key that you specify for the project that you specify. +* :ref:`atlas-api-programmaticApiKeys-addProjectApiKey` - `experimental `: Assigns the specified organization API key to the specified project. +* :ref:`atlas-api-programmaticApiKeys-createApiKey` - `experimental `: Creates one API key for the specified organization. +* :ref:`atlas-api-programmaticApiKeys-createApiKeyAccessList` - `experimental `: Creates the access list entries for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-createProjectApiKey` - `experimental `: Creates and assigns the specified organization API key to the specified project. +* :ref:`atlas-api-programmaticApiKeys-deleteApiKey` - `experimental `: Removes one organization API key from the specified organization. +* :ref:`atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry` - `experimental `: Removes the specified access list entry from the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-getApiKey` - `experimental `: Returns one organization API key. +* :ref:`atlas-api-programmaticApiKeys-getApiKeyAccessList` - `experimental `: Returns one access list entry for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries` - `experimental `: Returns all access list entries that you configured for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-listApiKeys` - `experimental `: Returns all organization API keys for the specified organization. +* :ref:`atlas-api-programmaticApiKeys-listProjectApiKeys` - `experimental `: Returns all organization API keys that you assigned to the specified project. +* :ref:`atlas-api-programmaticApiKeys-removeProjectApiKey` - `experimental `: Removes one organization API key from the specified project. +* :ref:`atlas-api-programmaticApiKeys-updateApiKey` - `experimental `: Updates one organization API key in the specified organization. +* :ref:`atlas-api-programmaticApiKeys-updateApiKeyRoles` - `experimental `: 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 ac9c253674..e8a358f06a 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 -experimental: Adds one or more access list entries to the specified project. +`experimental `: Adds one or more access list entries to the specified project. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent POST requests. You must submit multiple POST requests synchronously. This command is invoking the endpoint with OperationID: 'createProjectIpAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/createProjectIpAccessList diff --git a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt index c95f9bcf5a..e79bd0b1a5 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 -experimental: Removes one access list entry from the specified project's IP access list. +`experimental `: Removes one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This command is invoking the endpoint with OperationID: 'deleteProjectIpAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/deleteProjectIpAccessList diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt index 0817450535..8dffd9deec 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 -experimental: Returns the status of one project IP access list entry. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'getProjectIpAccessListStatus'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpAccessListStatus diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt index 8391e30fd6..eca2d43822 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 -experimental: Returns one access list entry from the specified project's IP access list. +`experimental `: Returns one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. This endpoint (/groups/{GROUP-ID}/accessList) manages the Project IP Access List. It doesn't manage the access list for MongoDB Cloud organizations. TheProgrammatic API Keys endpoint (/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist) manages those access lists. This command is invoking the endpoint with OperationID: 'getProjectIpList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpList diff --git a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt b/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt index f1fa26d033..a72c8cdc9d 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 -experimental: Returns all access list entries from the specified project's IP access list. +`experimental `: Returns all access list entries from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This command is invoking the endpoint with OperationID: 'listProjectIpAccessLists'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/listProjectIpAccessLists diff --git a/docs/command/atlas-api-projectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList.txt index d604f1c26c..5fd6e3981f 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 -experimental: Returns, adds, edits, and removes network access limits to database deployments in Atlas. +`experimental `: 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 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projectIpAccessList-createProjectIpAccessList` - experimental: Adds one or more access list entries to the specified project. -* :ref:`atlas-api-projectIpAccessList-deleteProjectIpAccessList` - experimental: Removes one access list entry from the specified project's IP access list. -* :ref:`atlas-api-projectIpAccessList-getProjectIpAccessListStatus` - experimental: Returns the status of one project IP access list entry. -* :ref:`atlas-api-projectIpAccessList-getProjectIpList` - experimental: Returns one access list entry from the specified project's IP access list. -* :ref:`atlas-api-projectIpAccessList-listProjectIpAccessLists` - experimental: Returns all access list entries from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-createProjectIpAccessList` - `experimental `: Adds one or more access list entries to the specified project. +* :ref:`atlas-api-projectIpAccessList-deleteProjectIpAccessList` - `experimental `: Removes one access list entry from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-getProjectIpAccessListStatus` - `experimental `: Returns the status of one project IP access list entry. +* :ref:`atlas-api-projectIpAccessList-getProjectIpList` - `experimental `: Returns one access list entry from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-listProjectIpAccessLists` - `experimental `: 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 8e246d2e32..ffd4e9d72a 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 -experimental: Adds one MongoDB Cloud user to the specified project. +`experimental `: Adds one MongoDB Cloud user to the specified project. If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting API Key must have the Group User Admin role. This command is invoking the endpoint with OperationID: 'addUserToProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/addUserToProject diff --git a/docs/command/atlas-api-projects-createProject.txt b/docs/command/atlas-api-projects-createProject.txt index 53ab43586a..e845688a6d 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 -experimental: Creates one project. +`experimental `: Creates one project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Read Write role. This command is invoking the endpoint with OperationID: 'createProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProject diff --git a/docs/command/atlas-api-projects-createProjectInvitation.txt b/docs/command/atlas-api-projects-createProjectInvitation.txt index 266d284979..442294ac73 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 -experimental: Invites one MongoDB Cloud user to join the specified project. +`experimental `: Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createProjectInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation diff --git a/docs/command/atlas-api-projects-deleteProject.txt b/docs/command/atlas-api-projects-deleteProject.txt index ca0d1446f5..085bf8ea7f 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 -experimental: Removes the specified project. +`experimental `: Removes the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProject diff --git a/docs/command/atlas-api-projects-deleteProjectInvitation.txt b/docs/command/atlas-api-projects-deleteProjectInvitation.txt index 7346601a47..d30807614e 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 -experimental: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. +`experimental `: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteProjectInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectInvitation diff --git a/docs/command/atlas-api-projects-deleteProjectLimit.txt b/docs/command/atlas-api-projects-deleteProjectLimit.txt index 4acda5aa63..5d39d8c960 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 -experimental: Removes the specified project limit. +`experimental `: Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteProjectLimit'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectLimit diff --git a/docs/command/atlas-api-projects-getProject.txt b/docs/command/atlas-api-projects-getProject.txt index 7fdba1618e..cda96f88fd 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 -experimental: Returns details about the specified project. +`experimental `: Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProject diff --git a/docs/command/atlas-api-projects-getProjectByName.txt b/docs/command/atlas-api-projects-getProjectByName.txt index 5c21198d3f..8f9a5dca81 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 -experimental: Returns details about the specified project. +`experimental `: Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getProjectByName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectByName diff --git a/docs/command/atlas-api-projects-getProjectInvitation.txt b/docs/command/atlas-api-projects-getProjectInvitation.txt index 0f275cf44e..1212c7331d 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 -experimental: Returns the details of one pending invitation to the specified project. +`experimental `: Returns the details of one pending invitation to the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getProjectInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectInvitation diff --git a/docs/command/atlas-api-projects-getProjectLimit.txt b/docs/command/atlas-api-projects-getProjectLimit.txt index baa4957100..e4b8bd351a 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 -experimental: Returns the specified limit for the specified project. +`experimental `: Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getProjectLimit'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLimit diff --git a/docs/command/atlas-api-projects-getProjectLtsVersions.txt b/docs/command/atlas-api-projects-getProjectLtsVersions.txt index 7387e932b0..0c26117ea1 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 -experimental: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. +`experimental `: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. This command is invoking the endpoint with OperationID: 'getProjectLtsVersions'. For more information about flags, format of --file and examples, see: 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 6ad98f9e4e..99faefa49c 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 -experimental: Returns details about the specified project's settings. +`experimental `: Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getProjectSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectSettings diff --git a/docs/command/atlas-api-projects-listProjectInvitations.txt b/docs/command/atlas-api-projects-listProjectInvitations.txt index 6583902f40..7656edb24a 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 -experimental: Returns all pending invitations to the specified project. +`experimental `: Returns all pending invitations to the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'listProjectInvitations'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectInvitations diff --git a/docs/command/atlas-api-projects-listProjectLimits.txt b/docs/command/atlas-api-projects-listProjectLimits.txt index 0426365e51..fc47ede3b9 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 -experimental: Returns all the limits for the specified project. +`experimental `: Returns all the limits for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listProjectLimits'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectLimits diff --git a/docs/command/atlas-api-projects-listProjectUsers.txt b/docs/command/atlas-api-projects-listProjectUsers.txt index 5860b2128f..751b879567 100644 --- a/docs/command/atlas-api-projects-listProjectUsers.txt +++ b/docs/command/atlas-api-projects-listProjectUsers.txt @@ -12,7 +12,7 @@ atlas api projects listProjectUsers :depth: 1 :class: singlecol -experimental: Returns details about all users in the specified project. +`experimental `: Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listProjectUsers'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectUsers diff --git a/docs/command/atlas-api-projects-listProjects.txt b/docs/command/atlas-api-projects-listProjects.txt index b91a56074b..d774e52738 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 -experimental: Returns details about all projects. +`experimental `: Returns details about all projects. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Organization Read Only role or higher. This command is invoking the endpoint with OperationID: 'listProjects'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjects diff --git a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt b/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt index 2ccd5dff3f..aae8b9d1fc 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 -experimental: Migrates a project from its current organization to another organization. +`experimental `: Migrates a project from its current organization to another organization. All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'migrateProjectToAnotherOrg'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/migrateProjectToAnotherOrg diff --git a/docs/command/atlas-api-projects-removeProjectUser.txt b/docs/command/atlas-api-projects-removeProjectUser.txt index 6dc98010d7..9e5b11b5dd 100644 --- a/docs/command/atlas-api-projects-removeProjectUser.txt +++ b/docs/command/atlas-api-projects-removeProjectUser.txt @@ -12,7 +12,7 @@ atlas api projects removeProjectUser :depth: 1 :class: singlecol -experimental: Removes the specified user from the specified project. +`experimental `: Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'removeProjectUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/removeProjectUser diff --git a/docs/command/atlas-api-projects-returnAllIpAddresses.txt b/docs/command/atlas-api-projects-returnAllIpAddresses.txt index 4e7aaec452..af715647be 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 -experimental: Returns all IP addresses for this project. +`experimental `: Returns all IP addresses for this project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'returnAllIpAddresses'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/returnAllIpAddresses diff --git a/docs/command/atlas-api-projects-setProjectLimit.txt b/docs/command/atlas-api-projects-setProjectLimit.txt index 6799eeef41..ab5635feef 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 -experimental: Sets the specified project limit. +`experimental `: Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role. NOTE: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern. This command is invoking the endpoint with OperationID: 'setProjectLimit'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/setProjectLimit diff --git a/docs/command/atlas-api-projects-updateProject.txt b/docs/command/atlas-api-projects-updateProject.txt index a0dac8c76c..427e0c331e 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 -experimental: Updates the human-readable label that identifies the specified project, or the tags associated with the project. +`experimental `: Updates the human-readable label that identifies the specified project, or the tags associated with the project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProject diff --git a/docs/command/atlas-api-projects-updateProjectInvitation.txt b/docs/command/atlas-api-projects-updateProjectInvitation.txt index 6f87c2020b..7f2652b665 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 -experimental: Updates the details of one pending invitation to the specified project. +`experimental `: Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateProjectInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitation diff --git a/docs/command/atlas-api-projects-updateProjectInvitationById.txt b/docs/command/atlas-api-projects-updateProjectInvitationById.txt index 250771a0d8..c82d251dcc 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 -experimental: Updates the details of one pending invitation to the specified project. +`experimental `: Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateProjectInvitationById'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitationById diff --git a/docs/command/atlas-api-projects-updateProjectRoles.txt b/docs/command/atlas-api-projects-updateProjectRoles.txt index 234fb5c504..ed2b69f961 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 -experimental: Updates the roles of the specified user in the specified project. +`experimental `: Updates the roles of the specified user in the specified project. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting API Key must have the Group User Admin role. This command is invoking the endpoint with OperationID: 'updateProjectRoles'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectRoles diff --git a/docs/command/atlas-api-projects-updateProjectSettings.txt b/docs/command/atlas-api-projects-updateProjectSettings.txt index 32f7bb095b..78bd546178 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 -experimental: Updates the settings of the specified project. +`experimental `: Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateProjectSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectSettings diff --git a/docs/command/atlas-api-projects.txt b/docs/command/atlas-api-projects.txt index 5601192d06..264950be38 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 -experimental: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. +`experimental `: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. Options ------- @@ -49,31 +49,31 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projects-addUserToProject` - experimental: Adds one MongoDB Cloud user to the specified project. -* :ref:`atlas-api-projects-createProject` - experimental: Creates one project. -* :ref:`atlas-api-projects-createProjectInvitation` - experimental: Invites one MongoDB Cloud user to join the specified project. -* :ref:`atlas-api-projects-deleteProject` - experimental: Removes the specified project. -* :ref:`atlas-api-projects-deleteProjectInvitation` - experimental: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. -* :ref:`atlas-api-projects-deleteProjectLimit` - experimental: Removes the specified project limit. -* :ref:`atlas-api-projects-getProject` - experimental: Returns details about the specified project. -* :ref:`atlas-api-projects-getProjectByName` - experimental: Returns details about the specified project. -* :ref:`atlas-api-projects-getProjectInvitation` - experimental: Returns the details of one pending invitation to the specified project. -* :ref:`atlas-api-projects-getProjectLimit` - experimental: Returns the specified limit for the specified project. -* :ref:`atlas-api-projects-getProjectLtsVersions` - experimental: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. -* :ref:`atlas-api-projects-getProjectSettings` - experimental: Returns details about the specified project's settings. -* :ref:`atlas-api-projects-listProjectInvitations` - experimental: Returns all pending invitations to the specified project. -* :ref:`atlas-api-projects-listProjectLimits` - experimental: Returns all the limits for the specified project. -* :ref:`atlas-api-projects-listProjectUsers` - experimental: Returns details about all users in the specified project. -* :ref:`atlas-api-projects-listProjects` - experimental: Returns details about all projects. -* :ref:`atlas-api-projects-migrateProjectToAnotherOrg` - experimental: Migrates a project from its current organization to another organization. -* :ref:`atlas-api-projects-removeProjectUser` - experimental: Removes the specified user from the specified project. -* :ref:`atlas-api-projects-returnAllIpAddresses` - experimental: Returns all IP addresses for this project. -* :ref:`atlas-api-projects-setProjectLimit` - experimental: Sets the specified project limit. -* :ref:`atlas-api-projects-updateProject` - experimental: Updates the human-readable label that identifies the specified project, or the tags associated with the project. -* :ref:`atlas-api-projects-updateProjectInvitation` - experimental: Updates the details of one pending invitation to the specified project. -* :ref:`atlas-api-projects-updateProjectInvitationById` - experimental: Updates the details of one pending invitation to the specified project. -* :ref:`atlas-api-projects-updateProjectRoles` - experimental: Updates the roles of the specified user in the specified project. -* :ref:`atlas-api-projects-updateProjectSettings` - experimental: Updates the settings of the specified project. +* :ref:`atlas-api-projects-addUserToProject` - `experimental `: Adds one MongoDB Cloud user to the specified project. +* :ref:`atlas-api-projects-createProject` - `experimental `: Creates one project. +* :ref:`atlas-api-projects-createProjectInvitation` - `experimental `: Invites one MongoDB Cloud user to join the specified project. +* :ref:`atlas-api-projects-deleteProject` - `experimental `: Removes the specified project. +* :ref:`atlas-api-projects-deleteProjectInvitation` - `experimental `: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. +* :ref:`atlas-api-projects-deleteProjectLimit` - `experimental `: Removes the specified project limit. +* :ref:`atlas-api-projects-getProject` - `experimental `: Returns details about the specified project. +* :ref:`atlas-api-projects-getProjectByName` - `experimental `: Returns details about the specified project. +* :ref:`atlas-api-projects-getProjectInvitation` - `experimental `: Returns the details of one pending invitation to the specified project. +* :ref:`atlas-api-projects-getProjectLimit` - `experimental `: Returns the specified limit for the specified project. +* :ref:`atlas-api-projects-getProjectLtsVersions` - `experimental `: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. +* :ref:`atlas-api-projects-getProjectSettings` - `experimental `: Returns details about the specified project's settings. +* :ref:`atlas-api-projects-listProjectInvitations` - `experimental `: Returns all pending invitations to the specified project. +* :ref:`atlas-api-projects-listProjectLimits` - `experimental `: Returns all the limits for the specified project. +* :ref:`atlas-api-projects-listProjectUsers` - `experimental `: Returns details about all users in the specified project. +* :ref:`atlas-api-projects-listProjects` - `experimental `: Returns details about all projects. +* :ref:`atlas-api-projects-migrateProjectToAnotherOrg` - `experimental `: Migrates a project from its current organization to another organization. +* :ref:`atlas-api-projects-removeProjectUser` - `experimental `: Removes the specified user from the specified project. +* :ref:`atlas-api-projects-returnAllIpAddresses` - `experimental `: Returns all IP addresses for this project. +* :ref:`atlas-api-projects-setProjectLimit` - `experimental `: Sets the specified project limit. +* :ref:`atlas-api-projects-updateProject` - `experimental `: Updates the human-readable label that identifies the specified project, or the tags associated with the project. +* :ref:`atlas-api-projects-updateProjectInvitation` - `experimental `: Updates the details of one pending invitation to the specified project. +* :ref:`atlas-api-projects-updateProjectInvitationById` - `experimental `: Updates the details of one pending invitation to the specified project. +* :ref:`atlas-api-projects-updateProjectRoles` - `experimental `: Updates the roles of the specified user in the specified project. +* :ref:`atlas-api-projects-updateProjectSettings` - `experimental `: 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 3af6ea4b69..acf0b675f4 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 -experimental: Configures the project level settings for the push-based log export feature. +`experimental `: Configures the project level settings for the push-based log export feature. This command is invoking the endpoint with OperationID: 'createPushBasedLogConfiguration'. For more information about flags, format of --file and examples, see: 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 f6607bc538..5ec7ba9fba 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 -experimental: Disables the push-based log export feature by resetting the project level settings to its default configuration. +`experimental `: Disables the push-based log export feature by resetting the project level settings to its default configuration. This command is invoking the endpoint with OperationID: 'deletePushBasedLogConfiguration'. For more information about flags, format of --file and examples, see: 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 ca57a1769c..190dfc9f67 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 -experimental: Fetches the current project level settings for the push-based log export feature. +`experimental `: Fetches the current project level settings for the push-based log export feature. This command is invoking the endpoint with OperationID: 'getPushBasedLogConfiguration'. For more information about flags, format of --file and examples, see: 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 37dbee0597..570f2427df 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 -experimental: Updates the project level settings for the push-based log export feature. +`experimental `: Updates the project level settings for the push-based log export feature. This command is invoking the endpoint with OperationID: 'updatePushBasedLogConfiguration'. For more information about flags, format of --file and examples, see: 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 bbee2f8a81..d4d6636a33 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 -experimental: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. +`experimental `: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes. @@ -51,10 +51,10 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-pushBasedLogExport-createPushBasedLogConfiguration` - experimental: Configures the project level settings for the push-based log export feature. -* :ref:`atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration` - experimental: Disables the push-based log export feature by resetting the project level settings to its default configuration. -* :ref:`atlas-api-pushBasedLogExport-getPushBasedLogConfiguration` - experimental: Fetches the current project level settings for the push-based log export feature. -* :ref:`atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration` - experimental: Updates the project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-createPushBasedLogConfiguration` - `experimental `: Configures the project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration` - `experimental `: Disables the push-based log export feature by resetting the project level settings to its default configuration. +* :ref:`atlas-api-pushBasedLogExport-getPushBasedLogConfiguration` - `experimental `: Fetches the current project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration` - `experimental `: 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 1964e20985..74923a4e1f 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 -experimental: Create one Atlas Resource Policy for an org. +`experimental `: Create one Atlas Resource Policy for an org. This command is invoking the endpoint with OperationID: 'createAtlasResourcePolicy'. For more information about flags, format of --file and examples, see: 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 46607e9731..0ceef61d9d 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 -experimental: Delete one Atlas Resource Policy for an org. +`experimental `: Delete one Atlas Resource Policy for an org. This command is invoking the endpoint with OperationID: 'deleteAtlasResourcePolicy'. For more information about flags, format of --file and examples, see: 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 80525e849e..dc79ddce14 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 -experimental: Return all Atlas Resource Policies for the org. +`experimental `: Return all Atlas Resource Policies for the org. This command is invoking the endpoint with OperationID: 'getAtlasResourcePolicies'. For more information about flags, format of --file and examples, see: 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 d93db429e3..04d1e53a05 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 -experimental: Return one Atlas Resource Policy for an org. +`experimental `: Return one Atlas Resource Policy for an org. This command is invoking the endpoint with OperationID: 'getAtlasResourcePolicy'. For more information about flags, format of --file and examples, see: 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 c284db07d0..6b0cbc7cc0 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 -experimental: Return all non-compliant resources for an org. +`experimental `: Return all non-compliant resources for an org. This command is invoking the endpoint with OperationID: 'getResourcesNonCompliant'. For more information about flags, format of --file and examples, see: 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 19bea4e391..307de5721b 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 -experimental: Update one Atlas Resource Policy for an org. +`experimental `: Update one Atlas Resource Policy for an org. This command is invoking the endpoint with OperationID: 'updateAtlasResourcePolicy'. For more information about flags, format of --file and examples, see: 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 21d5aee8aa..f05bb0aa8d 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 -experimental: Validate one Atlas Resource Policy for an org. +`experimental `: Validate one Atlas Resource Policy for an org. This command is invoking the endpoint with OperationID: 'validateAtlasResourcePolicy'. For more information about flags, format of --file and examples, see: 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 136e70c518..facb88af23 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 -experimental: Configure and manage Atlas Resource Policies within your organization. +`experimental `: Configure and manage Atlas Resource Policies within your organization. Options ------- @@ -49,13 +49,13 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-resourcePolicies-createAtlasResourcePolicy` - experimental: Create one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-deleteAtlasResourcePolicy` - experimental: Delete one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicies` - experimental: Return all Atlas Resource Policies for the org. -* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicy` - experimental: Return one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getResourcesNonCompliant` - experimental: Return all non-compliant resources for an org. -* :ref:`atlas-api-resourcePolicies-updateAtlasResourcePolicy` - experimental: Update one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-validateAtlasResourcePolicy` - experimental: Validate one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-createAtlasResourcePolicy` - `experimental `: Create one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-deleteAtlasResourcePolicy` - `experimental `: Delete one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicies` - `experimental `: Return all Atlas Resource Policies for the org. +* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicy` - `experimental `: Return one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-getResourcesNonCompliant` - `experimental `: Return all non-compliant resources for an org. +* :ref:`atlas-api-resourcePolicies-updateAtlasResourcePolicy` - `experimental `: Update one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-validateAtlasResourcePolicy` - `experimental `: 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 8a6a76f7f8..5698cbc45d 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 -experimental: Creates an index on the cluster identified by its name in a rolling manner. +`experimental `: Creates an index on the cluster identified by its name in a rolling manner. Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'createRollingIndex'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Rolling-Index/operation/createRollingIndex diff --git a/docs/command/atlas-api-rollingIndex.txt b/docs/command/atlas-api-rollingIndex.txt index 6a1465cbc8..aecde57d09 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 -experimental: Creates one index to a database deployment in a rolling manner. +`experimental `: 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 +51,7 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-rollingIndex-createRollingIndex` - experimental: Creates an index on the cluster identified by its name in a rolling manner. +* :ref:`atlas-api-rollingIndex-createRollingIndex` - `experimental `: 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 f9a85ed69b..9d997c98da 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 -experimental: This resource returns information about the MongoDB application along with API key meta data. +`experimental `: This resource returns information about the MongoDB application along with API key meta data. This command is invoking the endpoint with OperationID: 'getSystemStatus'. For more information about flags, format of --file and examples, see: 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 b94385c5c2..baad337e06 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 -experimental: Returns all control plane IP addresses. +`experimental `: Returns all control plane IP addresses. This command is invoking the endpoint with OperationID: 'returnAllControlPlaneIpAddresses'. For more information about flags, format of --file and examples, see: 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 63139ae055..be5b83d4cd 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 -experimental: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. +`experimental `: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API. @@ -51,8 +51,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-root-getSystemStatus` - experimental: This resource returns information about the MongoDB application along with API key meta data. -* :ref:`atlas-api-root-returnAllControlPlaneIpAddresses` - experimental: Returns all control plane IP addresses. +* :ref:`atlas-api-root-getSystemStatus` - `experimental `: This resource returns information about the MongoDB application along with API key meta data. +* :ref:`atlas-api-root-returnAllControlPlaneIpAddresses` - `experimental `: 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 a1b4d20fc0..2f9c2616aa 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 -experimental: Creates one serverless instance in the specified project. +`experimental `: Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createServerlessInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance diff --git a/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt index 00da1455af..b15d433214 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 -experimental: Removes one serverless instance from the specified project. +`experimental `: Removes one serverless instance from the specified project. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteServerlessInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/deleteServerlessInstance diff --git a/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt index b8086fa778..5f3e546c1d 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 -experimental: Returns details for one serverless instance in the specified project. +`experimental `: Returns details for one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getServerlessInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/getServerlessInstance diff --git a/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt b/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt index dbd360bb96..aa9c080c9c 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 -experimental: Returns details for all serverless instances in the specified project. +`experimental `: Returns details for all serverless instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listServerlessInstances'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/listServerlessInstances diff --git a/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt index 007fc82495..9a85fe6363 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 -experimental: Updates one serverless instance in the specified project. +`experimental `: Updates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateServerlessInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/updateServerlessInstance diff --git a/docs/command/atlas-api-serverlessInstances.txt b/docs/command/atlas-api-serverlessInstances.txt index 479550b38d..2a91e7f74c 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 -experimental: Returns, adds, edits, and removes serverless instances. +`experimental `: Returns, adds, edits, and removes serverless instances. Options ------- @@ -49,11 +49,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serverlessInstances-createServerlessInstance` - experimental: Creates one serverless instance in the specified project. -* :ref:`atlas-api-serverlessInstances-deleteServerlessInstance` - experimental: Removes one serverless instance from the specified project. -* :ref:`atlas-api-serverlessInstances-getServerlessInstance` - experimental: Returns details for one serverless instance in the specified project. -* :ref:`atlas-api-serverlessInstances-listServerlessInstances` - experimental: Returns details for all serverless instances in the specified project. -* :ref:`atlas-api-serverlessInstances-updateServerlessInstance` - experimental: Updates one serverless instance in the specified project. +* :ref:`atlas-api-serverlessInstances-createServerlessInstance` - `experimental `: Creates one serverless instance in the specified project. +* :ref:`atlas-api-serverlessInstances-deleteServerlessInstance` - `experimental `: Removes one serverless instance from the specified project. +* :ref:`atlas-api-serverlessInstances-getServerlessInstance` - `experimental `: Returns details for one serverless instance in the specified project. +* :ref:`atlas-api-serverlessInstances-listServerlessInstances` - `experimental `: Returns details for all serverless instances in the specified project. +* :ref:`atlas-api-serverlessInstances-updateServerlessInstance` - `experimental `: 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 937809677c..95722737e9 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 -experimental: Creates one private endpoint for one serverless instance. +`experimental `: Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance. This command is invoking the endpoint with OperationID: 'createServerlessPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/createServerlessPrivateEndpoint diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt index 88ef894569..eb5b0ef6be 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 -experimental: Remove one private endpoint from one serverless instance. +`experimental `: Remove one private endpoint from one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteServerlessPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/deleteServerlessPrivateEndpoint diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt index 1e752cfff9..e05c2a9e71 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 -experimental: Return one private endpoint for one serverless instance. +`experimental `: Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. This command is invoking the endpoint with OperationID: 'getServerlessPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/getServerlessPrivateEndpoint diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt index e752f068c9..b220c5890d 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 -experimental: Returns all private endpoints for one serverless instance. +`experimental `: Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource. This command is invoking the endpoint with OperationID: 'listServerlessPrivateEndpoints'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/listServerlessPrivateEndpoints diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt index 367dca6425..217e1b3a6b 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 -experimental: Updates one private endpoint for one serverless instance. +`experimental `: Updates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateServerlessPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/updateServerlessPrivateEndpoint diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints.txt b/docs/command/atlas-api-serverlessPrivateEndpoints.txt index de3d7016c7..57d4a01683 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 -experimental: Returns, adds, edits, and removes private endpoints for serverless instances. +`experimental `: 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 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint` - experimental: Creates one private endpoint for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint` - experimental: Remove one private endpoint from one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint` - experimental: Return one private endpoint for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints` - experimental: Returns all private endpoints for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint` - experimental: Updates one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint` - `experimental `: Creates one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint` - `experimental `: Remove one private endpoint from one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint` - `experimental `: Return one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints` - `experimental `: Returns all private endpoints for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint` - `experimental `: 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 9df8b781f5..8846bc27e4 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 -experimental: Assigns the specified Service Account to the specified Project. +`experimental `: Assigns the specified Service Account to the specified Project. Available as a preview feature. This command is invoking the endpoint with OperationID: 'addProjectServiceAccount'. For more information about flags, format of --file and examples, see: 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 7dc79e0c40..cec7da0962 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 -experimental: Creates one Service Account for the specified Project. +`experimental `: Creates one Service Account for the specified Project. The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. Available as a preview feature. This command is invoking the endpoint with OperationID: 'createProjectServiceAccount'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccount diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt index fd28fead00..e417d0f838 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 -experimental: Add Access List Entries for the specified Service Account for the project. +`experimental `: Add Access List Entries for the specified Service Account for the project. Resources require all API requests to originate from IP addresses on the API access list. Available as a preview feature. This command is invoking the endpoint with OperationID: 'createProjectServiceAccountAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountAccessList diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt index ee1e6d8ec7..0f0b224a83 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 -experimental: Create a secret for the specified Service Account in the specified Project. +`experimental `: Create a secret for the specified Service Account in the specified Project. Available as a preview feature. This command is invoking the endpoint with OperationID: 'createProjectServiceAccountSecret'. For more information about flags, format of --file and examples, see: 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 8d02d74b35..cbab83fc31 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 -experimental: Creates one Service Account for the specified Organization. +`experimental `: Creates one Service Account for the specified Organization. Available as a preview feature. This command is invoking the endpoint with OperationID: 'createServiceAccount'. For more information about flags, format of --file and examples, see: 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 9baafed309..c74a99a735 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 -experimental: Add Access List Entries for the specified Service Account for the organization. +`experimental `: 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. Available as a preview feature. This command is invoking the endpoint with OperationID: 'createServiceAccountAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountAccessList diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt index f3330bffcb..b336807572 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 -experimental: Create a secret for the specified Service Account. +`experimental `: Create a secret for the specified Service Account. Available as a preview feature. This command is invoking the endpoint with OperationID: 'createServiceAccountSecret'. For more information about flags, format of --file and examples, see: 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 8f66740fce..242a4609fa 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 -experimental: Removes the specified Service Account from the specified project. +`experimental `: Removes the specified Service Account from the specified project. The Service Account will still be a part of the Organization it was created in, and the credentials will remain active until expired or manually revoked. Available as a preview feature. This command is invoking the endpoint with OperationID: 'deleteProjectServiceAccount'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccount diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt index dab82845f3..8e5466982d 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 -experimental: Removes the specified access list entry from the specified Service Account for the project. +`experimental `: Removes the specified access list entry from the specified Service Account for the project. You can't remove the requesting IP address from the access list. Available as a preview feature. This command is invoking the endpoint with OperationID: 'deleteProjectServiceAccountAccessListEntry'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountAccessListEntry diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt index 107ba8af20..e340b70219 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 -experimental: Deletes the specified Service Account secret. +`experimental `: Deletes the specified Service Account secret. Available as a preview feature. This command is invoking the endpoint with OperationID: 'deleteProjectServiceAccountSecret'. For more information about flags, format of --file and examples, see: 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 dce2e70b86..20676f74e8 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 -experimental: Deletes the specified Service Account. +`experimental `: Deletes the specified Service Account. Available as a preview feature. This command is invoking the endpoint with OperationID: 'deleteServiceAccount'. For more information about flags, format of --file and examples, see: 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 1c3f6ce45a..cedcdc0003 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 -experimental: Removes the specified access list entry from the specified Service Account for the organization. +`experimental `: 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. Available as a preview feature. This command is invoking the endpoint with OperationID: 'deleteServiceAccountAccessListEntry'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountAccessListEntry diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt index 7f61d8452b..7cf8acfa8b 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 -experimental: Deletes the specified Service Account secret. +`experimental `: Deletes the specified Service Account secret. Available as a preview feature. This command is invoking the endpoint with OperationID: 'deleteServiceAccountSecret'. For more information about flags, format of --file and examples, see: 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 09d0c51ac1..1e09c18650 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 -experimental: Returns one Service Account in the specified Project. +`experimental `: Returns one Service Account in the specified Project. Available as a preview feature. This command is invoking the endpoint with OperationID: 'getProjectServiceAccount'. For more information about flags, format of --file and examples, see: 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 6efaa56ecb..9f19540134 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 -experimental: Returns the specified Service Account. +`experimental `: Returns the specified Service Account. Available as a preview feature. This command is invoking the endpoint with OperationID: 'getServiceAccount'. For more information about flags, format of --file and examples, see: 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 d99adb8cad..5f85854ffa 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 -experimental: Returns all access list entries that you configured for the specified Service Account for the project. +`experimental `: Returns all access list entries that you configured for the specified Service Account for the project. Available as a preview feature. This command is invoking the endpoint with OperationID: 'listProjectServiceAccountAccessList'. For more information about flags, format of --file and examples, see: 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 91a1209982..fb7bd5250e 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 -experimental: Returns all Service Accounts for the specified Project. +`experimental `: Returns all Service Accounts for the specified Project. Available as a preview feature. This command is invoking the endpoint with OperationID: 'listProjectServiceAccounts'. For more information about flags, format of --file and examples, see: 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 ade1546555..547d388f71 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 -experimental: Returns all access list entries that you configured for the specified Service Account for the organization. +`experimental `: Returns all access list entries that you configured for the specified Service Account for the organization. Available as a preview feature. This command is invoking the endpoint with OperationID: 'listServiceAccountAccessList'. For more information about flags, format of --file and examples, see: 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 5e2d72bf36..8c683f0d0d 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 -experimental: Returns a list of all projects the specified Service Account is a part of. +`experimental `: Returns a list of all projects the specified Service Account is a part of. Available as a preview feature. This command is invoking the endpoint with OperationID: 'listServiceAccountProjects'. For more information about flags, format of --file and examples, see: 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 e380cc7732..a8081cd1a1 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 -experimental: Returns all Service Accounts for the specified Organization. +`experimental `: Returns all Service Accounts for the specified Organization. Available as a preview feature. This command is invoking the endpoint with OperationID: 'listServiceAccounts'. For more information about flags, format of --file and examples, see: 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 d8c20ad95d..5c8386fba0 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 -experimental: Updates one Service Account in the specified Project. +`experimental `: Updates one Service Account in the specified Project. Available as a preview feature. This command is invoking the endpoint with OperationID: 'updateProjectServiceAccount'. For more information about flags, format of --file and examples, see: 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 39967d9d42..a37a4fd15b 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 -experimental: Updates the specified Service Account in the specified Organization. +`experimental `: Updates the specified Service Account in the specified Organization. Available as a preview feature. This command is invoking the endpoint with OperationID: 'updateServiceAccount'. For more information about flags, format of --file and examples, see: 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 5c14bdd3a8..0e8f43386a 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 -experimental: Endpoints for managing Service Accounts and secrets. +`experimental `: Endpoints for managing Service Accounts and secrets. Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow. This feature is available as a Preview feature. @@ -51,28 +51,28 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serviceAccounts-addProjectServiceAccount` - experimental: Assigns the specified Service Account to the specified Project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccount` - experimental: Creates one Service Account for the specified Project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountAccessList` - experimental: Add Access List Entries for the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountSecret` - experimental: Create a secret for the specified Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-createServiceAccount` - experimental: Creates one Service Account for the specified Organization. -* :ref:`atlas-api-serviceAccounts-createServiceAccountAccessList` - experimental: Add Access List Entries for the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-createServiceAccountSecret` - experimental: Create a secret for the specified Service Account. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccount` - experimental: Removes the specified Service Account from the specified project. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry` - experimental: Removes the specified access list entry from the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountSecret` - experimental: Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccount` - experimental: Deletes the specified Service Account. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry` - experimental: Removes the specified access list entry from the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccountSecret` - experimental: Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-getProjectServiceAccount` - experimental: Returns one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-getServiceAccount` - experimental: Returns the specified Service Account. -* :ref:`atlas-api-serviceAccounts-listProjectServiceAccountAccessList` - experimental: Returns all access list entries that you configured for the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-listProjectServiceAccounts` - experimental: Returns all Service Accounts for the specified Project. -* :ref:`atlas-api-serviceAccounts-listServiceAccountAccessList` - experimental: Returns all access list entries that you configured for the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-listServiceAccountProjects` - experimental: Returns a list of all projects the specified Service Account is a part of. -* :ref:`atlas-api-serviceAccounts-listServiceAccounts` - experimental: Returns all Service Accounts for the specified Organization. -* :ref:`atlas-api-serviceAccounts-updateProjectServiceAccount` - experimental: Updates one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-updateServiceAccount` - experimental: Updates the specified Service Account in the specified Organization. +* :ref:`atlas-api-serviceAccounts-addProjectServiceAccount` - `experimental `: Assigns the specified Service Account to the specified Project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccount` - `experimental `: Creates one Service Account for the specified Project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountAccessList` - `experimental `: Add Access List Entries for the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountSecret` - `experimental `: Create a secret for the specified Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-createServiceAccount` - `experimental `: Creates one Service Account for the specified Organization. +* :ref:`atlas-api-serviceAccounts-createServiceAccountAccessList` - `experimental `: Add Access List Entries for the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-createServiceAccountSecret` - `experimental `: Create a secret for the specified Service Account. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccount` - `experimental `: Removes the specified Service Account from the specified project. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry` - `experimental `: Removes the specified access list entry from the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountSecret` - `experimental `: Deletes the specified Service Account secret. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccount` - `experimental `: Deletes the specified Service Account. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry` - `experimental `: Removes the specified access list entry from the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccountSecret` - `experimental `: Deletes the specified Service Account secret. +* :ref:`atlas-api-serviceAccounts-getProjectServiceAccount` - `experimental `: Returns one Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-getServiceAccount` - `experimental `: Returns the specified Service Account. +* :ref:`atlas-api-serviceAccounts-listProjectServiceAccountAccessList` - `experimental `: Returns all access list entries that you configured for the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-listProjectServiceAccounts` - `experimental `: Returns all Service Accounts for the specified Project. +* :ref:`atlas-api-serviceAccounts-listServiceAccountAccessList` - `experimental `: Returns all access list entries that you configured for the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-listServiceAccountProjects` - `experimental `: Returns a list of all projects the specified Service Account is a part of. +* :ref:`atlas-api-serviceAccounts-listServiceAccounts` - `experimental `: Returns all Service Accounts for the specified Organization. +* :ref:`atlas-api-serviceAccounts-updateProjectServiceAccount` - `experimental `: Updates one Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-updateServiceAccount` - `experimental `: 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 47fa2dbcb1..601be67fe0 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 -experimental: Restores the specified cluster. +`experimental `: Restores the specified cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createSharedClusterBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/createSharedClusterBackupRestoreJob diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt b/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt index 88065e55db..ed1c089772 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 -experimental: Returns the specified restore job. +`experimental `: Returns the specified restore job. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getSharedClusterBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/getSharedClusterBackupRestoreJob diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt b/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt index 0730260470..2b63fd6276 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 -experimental: Returns all restore jobs for the specified M2 or M5 cluster. +`experimental `: Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listSharedClusterBackupRestoreJobs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/listSharedClusterBackupRestoreJobs diff --git a/docs/command/atlas-api-sharedTierRestoreJobs.txt b/docs/command/atlas-api-sharedTierRestoreJobs.txt index 9e2f32b8d5..7697ace148 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 -experimental: Returns and adds restore jobs for shared-tier database deployments. +`experimental `: Returns and adds restore jobs for shared-tier database deployments. Options ------- @@ -49,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob` - experimental: Restores the specified cluster. -* :ref:`atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob` - experimental: Returns the specified restore job. -* :ref:`atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs` - experimental: Returns all restore jobs for the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob` - `experimental `: Restores the specified cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob` - `experimental `: Returns the specified restore job. +* :ref:`atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs` - `experimental `: 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 c61d7123f8..4f34949e53 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 -experimental: Requests one snapshot for the specified shared cluster. +`experimental `: Requests one snapshot for the specified shared cluster. This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'downloadSharedClusterBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/downloadSharedClusterBackup diff --git a/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt b/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt index 8438a7caad..483ce26132 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 -experimental: Returns details for one snapshot for the specified shared cluster. +`experimental `: Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getSharedClusterBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/getSharedClusterBackup diff --git a/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt b/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt index f894724046..b4ca12c5eb 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 -experimental: Returns details for all snapshots for the specified shared cluster. +`experimental `: Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listSharedClusterBackups'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/listSharedClusterBackups diff --git a/docs/command/atlas-api-sharedTierSnapshots.txt b/docs/command/atlas-api-sharedTierSnapshots.txt index ebc883786e..5ef58a1c4d 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 -experimental: Returns and requests to download shared-tier database deployment snapshots. +`experimental `: Returns and requests to download shared-tier database deployment snapshots. Options ------- @@ -49,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierSnapshots-downloadSharedClusterBackup` - experimental: Requests one snapshot for the specified shared cluster. -* :ref:`atlas-api-sharedTierSnapshots-getSharedClusterBackup` - experimental: Returns details for one snapshot for the specified shared cluster. -* :ref:`atlas-api-sharedTierSnapshots-listSharedClusterBackups` - experimental: Returns details for all snapshots for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-downloadSharedClusterBackup` - `experimental `: Requests one snapshot for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-getSharedClusterBackup` - `experimental `: Returns details for one snapshot for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-listSharedClusterBackups` - `experimental `: 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 770122c1a2..a51fc213d5 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 -experimental: Requests the acceptance of an incoming VPC Peering connection. +`experimental `: Requests the acceptance of an incoming VPC Peering connection. This command is invoking the endpoint with OperationID: 'acceptVpcPeeringConnection'. For more information about flags, format of --file and examples, see: 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 2ff41904a7..9702e2ba76 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 -experimental: Creates one Private Link in the specified project. +`experimental `: Creates one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'createPrivateLinkConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createPrivateLinkConnection diff --git a/docs/command/atlas-api-streams-createStreamConnection.txt b/docs/command/atlas-api-streams-createStreamConnection.txt index 1942d5d70d..4cf0b77d06 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 -experimental: Creates one connection for a stream instance in the specified project. +`experimental `: Creates one connection for a stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'createStreamConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamConnection diff --git a/docs/command/atlas-api-streams-createStreamInstance.txt b/docs/command/atlas-api-streams-createStreamInstance.txt index c30d372a17..f0cfea2719 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 -experimental: Creates one stream instance in the specified project. +`experimental `: Creates one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'createStreamInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstance diff --git a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt b/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt index 2bb9d8def9..ab47da65d2 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 -experimental: Creates one stream instance in the specified project with sample connections. +`experimental `: Creates one stream instance in the specified project with sample connections. To use this resource the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'createStreamInstanceWithSampleConnections'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstanceWithSampleConnections diff --git a/docs/command/atlas-api-streams-createStreamProcessor.txt b/docs/command/atlas-api-streams-createStreamProcessor.txt index 3e6c711f85..53d0e8425a 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 -experimental: Create one Stream Processor within the specified stream instance. +`experimental `: Create one Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'createStreamProcessor'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamProcessor diff --git a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt index 4a2af1653f..0533fc08ea 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 -experimental: Deletes one Private Link in the specified project. +`experimental `: Deletes one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'deletePrivateLinkConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deletePrivateLinkConnection diff --git a/docs/command/atlas-api-streams-deleteStreamConnection.txt b/docs/command/atlas-api-streams-deleteStreamConnection.txt index 22c59dcfd2..9c3df627dd 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 -experimental: Delete one connection of the specified stream instance. +`experimental `: Delete one connection of the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'deleteStreamConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamConnection diff --git a/docs/command/atlas-api-streams-deleteStreamInstance.txt b/docs/command/atlas-api-streams-deleteStreamInstance.txt index 128c879dce..cde7a2b2d2 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 -experimental: Delete one stream instance in the specified project. +`experimental `: Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'deleteStreamInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamInstance diff --git a/docs/command/atlas-api-streams-deleteStreamProcessor.txt b/docs/command/atlas-api-streams-deleteStreamProcessor.txt index 921498a537..8696dd75be 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 -experimental: Delete a Stream Processor within the specified stream instance. +`experimental `: Delete a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'deleteStreamProcessor'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamProcessor diff --git a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt index d4312aff64..804fbc51c1 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 -experimental: Deletes an incoming VPC Peering connection. +`experimental `: Deletes an incoming VPC Peering connection. This command is invoking the endpoint with OperationID: 'deleteVpcPeeringConnection'. For more information about flags, format of --file and examples, see: 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 b4f163371b..7c1f029503 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 -experimental: Downloads the audit logs for the specified Atlas Streams Processing instance. +`experimental `: Downloads the audit logs for the specified Atlas Streams Processing instance. By default, logs cover periods of 30 days. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". This command is invoking the endpoint with OperationID: 'downloadStreamTenantAuditLogs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/downloadStreamTenantAuditLogs diff --git a/docs/command/atlas-api-streams-getAccountDetails.txt b/docs/command/atlas-api-streams-getAccountDetails.txt index 94af8fd7d6..069b39ea35 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 -experimental: Returns the Account ID, and the VPC ID for the group and region specified. +`experimental `: Returns the Account ID, and the VPC ID for the group and region specified. This command is invoking the endpoint with OperationID: 'getAccountDetails'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getAccountDetails diff --git a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt index e1fb47dc66..2f58dce7b4 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 -experimental: Returns the details of one Private Link connection within the project. +`experimental `: Returns the details of one Private Link connection within the project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPrivateLinkConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getPrivateLinkConnection diff --git a/docs/command/atlas-api-streams-getStreamConnection.txt b/docs/command/atlas-api-streams-getStreamConnection.txt index c10bc38d1b..ef1bfa71c6 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 -experimental: Returns the details of one stream connection within the specified stream instance. +`experimental `: Returns the details of one stream connection within the specified stream instance. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getStreamConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamConnection diff --git a/docs/command/atlas-api-streams-getStreamInstance.txt b/docs/command/atlas-api-streams-getStreamInstance.txt index d0c31a2f79..6e89f970e1 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 -experimental: Returns the details of one stream instance within the specified project. +`experimental `: Returns the details of one stream instance within the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'getStreamInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamInstance diff --git a/docs/command/atlas-api-streams-getStreamProcessor.txt b/docs/command/atlas-api-streams-getStreamProcessor.txt index 8afcbe0274..3187eaac7e 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 -experimental: Get one Stream Processor within the specified stream instance. +`experimental `: Get one Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'getStreamProcessor'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamProcessor diff --git a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getVpcPeeringConnections.txt index e9ccdcb4c4..b1d911295e 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 -experimental: Returns a list of incoming VPC Peering Connections. +`experimental `: Returns a list of incoming VPC Peering Connections. This command is invoking the endpoint with OperationID: 'getVpcPeeringConnections'. For more information about flags, format of --file and examples, see: 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 5ceb6b3a6d..2b35e2b82e 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 -experimental: 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. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'listPrivateLinkConnections'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listPrivateLinkConnections diff --git a/docs/command/atlas-api-streams-listStreamConnections.txt b/docs/command/atlas-api-streams-listStreamConnections.txt index d263c29d43..9279ce3dd4 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 -experimental: 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. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'listStreamConnections'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamConnections diff --git a/docs/command/atlas-api-streams-listStreamInstances.txt b/docs/command/atlas-api-streams-listStreamInstances.txt index 71511aee2a..4c255332ed 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 -experimental: Returns all stream instances for the specified project. +`experimental `: Returns all stream instances for the specified project. This command is invoking the endpoint with OperationID: 'listStreamInstances'. For more information about flags, format of --file and examples, see: 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 04f86243a4..6ac63fd2c3 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 -experimental: Returns all Stream Processors within the specified stream instance. +`experimental `: Returns all Stream Processors within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'listStreamProcessors'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamProcessors diff --git a/docs/command/atlas-api-streams-modifyStreamProcessor.txt b/docs/command/atlas-api-streams-modifyStreamProcessor.txt index 9f37762611..7b6d82bae5 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 -experimental: Modify one existing Stream Processor within the specified stream instance. +`experimental `: Modify one existing Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'modifyStreamProcessor'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/modifyStreamProcessor diff --git a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt index df9b1e6bd3..1f1d17eca4 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 -experimental: Requests the rejection of an incoming VPC Peering connection. +`experimental `: Requests the rejection of an incoming VPC Peering connection. This command is invoking the endpoint with OperationID: 'rejectVpcPeeringConnection'. For more information about flags, format of --file and examples, see: 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 09c9aa0f26..4ffadc2926 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 -experimental: Start a Stream Processor within the specified stream instance. +`experimental `: Start a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'startStreamProcessor'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startStreamProcessor diff --git a/docs/command/atlas-api-streams-stopStreamProcessor.txt b/docs/command/atlas-api-streams-stopStreamProcessor.txt index 2524fc6ea7..775fdffc66 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 -experimental: Stop a Stream Processor within the specified stream instance. +`experimental `: Stop a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'stopStreamProcessor'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/stopStreamProcessor diff --git a/docs/command/atlas-api-streams-updateStreamConnection.txt b/docs/command/atlas-api-streams-updateStreamConnection.txt index 550296996b..6531ed31f9 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 -experimental: Update one connection for the specified stream instance in the specified project. +`experimental `: Update one connection for the specified stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'updateStreamConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamConnection diff --git a/docs/command/atlas-api-streams-updateStreamInstance.txt b/docs/command/atlas-api-streams-updateStreamInstance.txt index f56f036a94..9219daa138 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 -experimental: Update one stream instance in the specified project. +`experimental `: Update one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'updateStreamInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamInstance diff --git a/docs/command/atlas-api-streams.txt b/docs/command/atlas-api-streams.txt index bfb2de47cf..401860af72 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 -experimental: Returns, adds, edits, and removes Streams Instances. +`experimental `: Returns, adds, edits, and removes Streams Instances. This resource requires your project ID. @@ -51,34 +51,34 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-streams-acceptVpcPeeringConnection` - experimental: Requests the acceptance of an incoming VPC Peering connection. -* :ref:`atlas-api-streams-createPrivateLinkConnection` - experimental: Creates one Private Link in the specified project. -* :ref:`atlas-api-streams-createStreamConnection` - experimental: Creates one connection for a stream instance in the specified project. -* :ref:`atlas-api-streams-createStreamInstance` - experimental: Creates one stream instance in the specified project. -* :ref:`atlas-api-streams-createStreamInstanceWithSampleConnections` - experimental: Creates one stream instance in the specified project with sample connections. -* :ref:`atlas-api-streams-createStreamProcessor` - experimental: Create one Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-deletePrivateLinkConnection` - experimental: Deletes one Private Link in the specified project. -* :ref:`atlas-api-streams-deleteStreamConnection` - experimental: Delete one connection of the specified stream instance. -* :ref:`atlas-api-streams-deleteStreamInstance` - experimental: Delete one stream instance in the specified project. -* :ref:`atlas-api-streams-deleteStreamProcessor` - experimental: Delete a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-deleteVpcPeeringConnection` - experimental: Deletes an incoming VPC Peering connection. -* :ref:`atlas-api-streams-downloadStreamTenantAuditLogs` - experimental: Downloads the audit logs for the specified Atlas Streams Processing instance. -* :ref:`atlas-api-streams-getAccountDetails` - experimental: Returns the Account ID, and the VPC ID for the group and region specified. -* :ref:`atlas-api-streams-getPrivateLinkConnection` - experimental: Returns the details of one Private Link connection within the project. -* :ref:`atlas-api-streams-getStreamConnection` - experimental: Returns the details of one stream connection within the specified stream instance. -* :ref:`atlas-api-streams-getStreamInstance` - experimental: Returns the details of one stream instance within the specified project. -* :ref:`atlas-api-streams-getStreamProcessor` - experimental: Get one Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-getVpcPeeringConnections` - experimental: Returns a list of incoming VPC Peering Connections. -* :ref:`atlas-api-streams-listPrivateLinkConnections` - experimental: 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. -* :ref:`atlas-api-streams-listStreamConnections` - experimental: 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. -* :ref:`atlas-api-streams-listStreamInstances` - experimental: Returns all stream instances for the specified project. -* :ref:`atlas-api-streams-listStreamProcessors` - experimental: Returns all Stream Processors within the specified stream instance. -* :ref:`atlas-api-streams-modifyStreamProcessor` - experimental: Modify one existing Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-rejectVpcPeeringConnection` - experimental: Requests the rejection of an incoming VPC Peering connection. -* :ref:`atlas-api-streams-startStreamProcessor` - experimental: Start a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-stopStreamProcessor` - experimental: Stop a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-updateStreamConnection` - experimental: Update one connection for the specified stream instance in the specified project. -* :ref:`atlas-api-streams-updateStreamInstance` - experimental: Update one stream instance in the specified project. +* :ref:`atlas-api-streams-acceptVpcPeeringConnection` - `experimental `: Requests the acceptance of an incoming VPC Peering connection. +* :ref:`atlas-api-streams-createPrivateLinkConnection` - `experimental `: Creates one Private Link in the specified project. +* :ref:`atlas-api-streams-createStreamConnection` - `experimental `: Creates one connection for a stream instance in the specified project. +* :ref:`atlas-api-streams-createStreamInstance` - `experimental `: Creates one stream instance in the specified project. +* :ref:`atlas-api-streams-createStreamInstanceWithSampleConnections` - `experimental `: Creates one stream instance in the specified project with sample connections. +* :ref:`atlas-api-streams-createStreamProcessor` - `experimental `: Create one Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-deletePrivateLinkConnection` - `experimental `: Deletes one Private Link in the specified project. +* :ref:`atlas-api-streams-deleteStreamConnection` - `experimental `: Delete one connection of the specified stream instance. +* :ref:`atlas-api-streams-deleteStreamInstance` - `experimental `: Delete one stream instance in the specified project. +* :ref:`atlas-api-streams-deleteStreamProcessor` - `experimental `: Delete a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-deleteVpcPeeringConnection` - `experimental `: Deletes an incoming VPC Peering connection. +* :ref:`atlas-api-streams-downloadStreamTenantAuditLogs` - `experimental `: Downloads the audit logs for the specified Atlas Streams Processing instance. +* :ref:`atlas-api-streams-getAccountDetails` - `experimental `: Returns the Account ID, and the VPC ID for the group and region specified. +* :ref:`atlas-api-streams-getPrivateLinkConnection` - `experimental `: Returns the details of one Private Link connection within the project. +* :ref:`atlas-api-streams-getStreamConnection` - `experimental `: Returns the details of one stream connection within the specified stream instance. +* :ref:`atlas-api-streams-getStreamInstance` - `experimental `: Returns the details of one stream instance within the specified project. +* :ref:`atlas-api-streams-getStreamProcessor` - `experimental `: Get one Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-getVpcPeeringConnections` - `experimental `: Returns a list of incoming VPC Peering Connections. +* :ref:`atlas-api-streams-listPrivateLinkConnections` - `experimental `: 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. +* :ref:`atlas-api-streams-listStreamConnections` - `experimental `: 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. +* :ref:`atlas-api-streams-listStreamInstances` - `experimental `: Returns all stream instances for the specified project. +* :ref:`atlas-api-streams-listStreamProcessors` - `experimental `: Returns all Stream Processors within the specified stream instance. +* :ref:`atlas-api-streams-modifyStreamProcessor` - `experimental `: Modify one existing Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-rejectVpcPeeringConnection` - `experimental `: Requests the rejection of an incoming VPC Peering connection. +* :ref:`atlas-api-streams-startStreamProcessor` - `experimental `: Start a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-stopStreamProcessor` - `experimental `: Stop a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-updateStreamConnection` - `experimental `: Update one connection for the specified stream instance in the specified project. +* :ref:`atlas-api-streams-updateStreamInstance` - `experimental `: 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 547b0a7271..7f3b4efd2a 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 -experimental: Adds one team to the specified project. +`experimental `: Adds one team to the specified project. All members of the team share the same project access. MongoDB Cloud limits the number of users to a maximum of 100 teams per project and a maximum of 250 teams per organization. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'addAllTeamsToProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addAllTeamsToProject diff --git a/docs/command/atlas-api-teams-addTeamUser.txt b/docs/command/atlas-api-teams-addTeamUser.txt index 74353b14ae..cc2a3687e1 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 -experimental: Adds one or more MongoDB Cloud users from the specified organization to the specified team. +`experimental `: Adds one or more MongoDB Cloud users from the specified organization to the specified team. Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'addTeamUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addTeamUser diff --git a/docs/command/atlas-api-teams-createTeam.txt b/docs/command/atlas-api-teams-createTeam.txt index 031707a9a1..c01446f955 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 -experimental: Creates one team in the specified organization. +`experimental `: Creates one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits the number of teams to a maximum of 250 teams per organization. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'createTeam'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/createTeam diff --git a/docs/command/atlas-api-teams-deleteTeam.txt b/docs/command/atlas-api-teams-deleteTeam.txt index a98263c340..4d1df65821 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 -experimental: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. +`experimental `: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'deleteTeam'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/deleteTeam diff --git a/docs/command/atlas-api-teams-getTeamById.txt b/docs/command/atlas-api-teams-getTeamById.txt index 740503ad3d..5a794de7cd 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 -experimental: Returns one team that you identified using its unique 24-hexadecimal digit ID. +`experimental `: Returns one team that you identified using its unique 24-hexadecimal digit ID. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'getTeamById'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamById diff --git a/docs/command/atlas-api-teams-getTeamByName.txt b/docs/command/atlas-api-teams-getTeamByName.txt index 6969559821..8648106881 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 -experimental: Returns one team that you identified using its human-readable name. +`experimental `: Returns one team that you identified using its human-readable name. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'getTeamByName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamByName diff --git a/docs/command/atlas-api-teams-listOrganizationTeams.txt b/docs/command/atlas-api-teams-listOrganizationTeams.txt index 7929adbde0..b21a5b55f0 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 -experimental: Returns all teams that belong to the specified organization. +`experimental `: Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listOrganizationTeams'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listOrganizationTeams diff --git a/docs/command/atlas-api-teams-listProjectTeams.txt b/docs/command/atlas-api-teams-listProjectTeams.txt index 1d5d7090d8..a4ceda61ca 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 -experimental: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. +`experimental `: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listProjectTeams'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listProjectTeams diff --git a/docs/command/atlas-api-teams-listTeamUsers.txt b/docs/command/atlas-api-teams-listTeamUsers.txt index a3f14b582c..c82946fb99 100644 --- a/docs/command/atlas-api-teams-listTeamUsers.txt +++ b/docs/command/atlas-api-teams-listTeamUsers.txt @@ -12,7 +12,7 @@ atlas api teams listTeamUsers :depth: 1 :class: singlecol -experimental: Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. +`experimental `: Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listTeamUsers'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listTeamUsers diff --git a/docs/command/atlas-api-teams-removeProjectTeam.txt b/docs/command/atlas-api-teams-removeProjectTeam.txt index 5ca4252ce5..685c96f12f 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 -experimental: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. +`experimental `: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'removeProjectTeam'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeProjectTeam diff --git a/docs/command/atlas-api-teams-removeTeamUser.txt b/docs/command/atlas-api-teams-removeTeamUser.txt index dfbf2b0991..722a4e281f 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 -experimental: Removes one MongoDB Cloud user from the specified team. +`experimental `: Removes one MongoDB Cloud user from the specified team. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'removeTeamUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeTeamUser diff --git a/docs/command/atlas-api-teams-renameTeam.txt b/docs/command/atlas-api-teams-renameTeam.txt index 7b0f5051b0..2be18fe45c 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 -experimental: Renames one team in the specified organization. +`experimental `: Renames one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'renameTeam'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/renameTeam diff --git a/docs/command/atlas-api-teams-updateTeamRoles.txt b/docs/command/atlas-api-teams-updateTeamRoles.txt index a42c78fa63..15af5a5c95 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 -experimental: Updates the project roles assigned to the specified team. +`experimental `: Updates the project roles assigned to the specified team. You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateTeamRoles'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/updateTeamRoles diff --git a/docs/command/atlas-api-teams.txt b/docs/command/atlas-api-teams.txt index ec05a80b2e..bd5f7b2743 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 -experimental: Returns, adds, edits, or removes teams. +`experimental `: Returns, adds, edits, or removes teams. Options ------- @@ -49,19 +49,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-teams-addAllTeamsToProject` - experimental: Adds one team to the specified project. -* :ref:`atlas-api-teams-addTeamUser` - experimental: Adds one or more MongoDB Cloud users from the specified organization to the specified team. -* :ref:`atlas-api-teams-createTeam` - experimental: Creates one team in the specified organization. -* :ref:`atlas-api-teams-deleteTeam` - experimental: 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` - experimental: Returns one team that you identified using its unique 24-hexadecimal digit ID. -* :ref:`atlas-api-teams-getTeamByName` - experimental: Returns one team that you identified using its human-readable name. -* :ref:`atlas-api-teams-listOrganizationTeams` - experimental: Returns all teams that belong to the specified organization. -* :ref:`atlas-api-teams-listProjectTeams` - experimental: 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-listTeamUsers` - experimental: Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. -* :ref:`atlas-api-teams-removeProjectTeam` - experimental: 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` - experimental: Removes one MongoDB Cloud user from the specified team. -* :ref:`atlas-api-teams-renameTeam` - experimental: Renames one team in the specified organization. -* :ref:`atlas-api-teams-updateTeamRoles` - experimental: Updates the project roles assigned to the specified team. +* :ref:`atlas-api-teams-addAllTeamsToProject` - `experimental `: Adds one team to the specified project. +* :ref:`atlas-api-teams-addTeamUser` - `experimental `: Adds one or more MongoDB Cloud users from the specified organization to the specified team. +* :ref:`atlas-api-teams-createTeam` - `experimental `: Creates one team in the specified organization. +* :ref:`atlas-api-teams-deleteTeam` - `experimental `: 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` - `experimental `: Returns one team that you identified using its unique 24-hexadecimal digit ID. +* :ref:`atlas-api-teams-getTeamByName` - `experimental `: Returns one team that you identified using its human-readable name. +* :ref:`atlas-api-teams-listOrganizationTeams` - `experimental `: Returns all teams that belong to the specified organization. +* :ref:`atlas-api-teams-listProjectTeams` - `experimental `: 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-listTeamUsers` - `experimental `: Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. +* :ref:`atlas-api-teams-removeProjectTeam` - `experimental `: 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` - `experimental `: Removes one MongoDB Cloud user from the specified team. +* :ref:`atlas-api-teams-renameTeam` - `experimental `: Renames one team in the specified organization. +* :ref:`atlas-api-teams-updateTeamRoles` - `experimental `: Updates the project roles assigned to the specified team. .. toctree:: diff --git a/docs/command/atlas-api-test-versionedExample.txt b/docs/command/atlas-api-test-versionedExample.txt index 869c9433be..84687f54e3 100644 --- a/docs/command/atlas-api-test-versionedExample.txt +++ b/docs/command/atlas-api-test-versionedExample.txt @@ -12,7 +12,7 @@ atlas api test versionedExample :depth: 1 :class: singlecol -experimental: Returns some text dummy data for test purposes. +`experimental `: Returns some text dummy data for test purposes. This command is invoking the endpoint with OperationID: 'versionedExample'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Test/operation/versionedExample diff --git a/docs/command/atlas-api-test.txt b/docs/command/atlas-api-test.txt index 77d95a090c..01292bdebf 100644 --- a/docs/command/atlas-api-test.txt +++ b/docs/command/atlas-api-test.txt @@ -12,7 +12,7 @@ atlas api test :depth: 1 :class: singlecol -experimental: Atlas test endpoints. +`experimental `: Atlas test endpoints. Options ------- @@ -49,7 +49,7 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-test-versionedExample` - experimental: Returns some text dummy data for test purposes. +* :ref:`atlas-api-test-versionedExample` - `experimental `: Returns some text dummy data for test purposes. .. toctree:: diff --git a/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt index edb6014435..f9c39a75a2 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 -experimental: Adds the settings for configuring one third-party service integration. +`experimental `: Adds the settings for configuring one third-party service integration. These settings apply to all databases managed in the specified MongoDB Cloud project. Each project can have only one configuration per {INTEGRATION-TYPE}. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This command is invoking the endpoint with OperationID: 'createThirdPartyIntegration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/createThirdPartyIntegration diff --git a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt index c28e7e38fb..6737d5312d 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 -experimental: Removes the settings that permit configuring one third-party service integration. +`experimental `: Removes the settings that permit configuring one third-party service integration. These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured {INTEGRATION-TYPE} integrations. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This command is invoking the endpoint with OperationID: 'deleteThirdPartyIntegration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/deleteThirdPartyIntegration diff --git a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt index 5caaa479a2..a402c23387 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 -experimental: Returns the settings for configuring integration with one third-party service. +`experimental `: Returns the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This command is invoking the endpoint with OperationID: 'getThirdPartyIntegration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/getThirdPartyIntegration diff --git a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt index eb3b5066ce..1a12163f81 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 -experimental: Returns the settings that permit integrations with all configured third-party services. +`experimental `: Returns the settings that permit integrations with all configured third-party services. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This command is invoking the endpoint with OperationID: 'listThirdPartyIntegrations'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/listThirdPartyIntegrations diff --git a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt index 7c22135456..14680f5d3a 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 -experimental: Updates the settings for configuring integration with one third-party service. +`experimental `: Updates the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This command is invoking the endpoint with OperationID: 'updateThirdPartyIntegration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/updateThirdPartyIntegration diff --git a/docs/command/atlas-api-thirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations.txt index 66c2b02969..dee51ace8b 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 -experimental: Returns, adds, edits, and removes third-party service integration configurations. +`experimental `: Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure. IMPORTANT: Each project can only have one configuration per integrationType. @@ -51,11 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-thirdPartyIntegrations-createThirdPartyIntegration` - experimental: Adds the settings for configuring one third-party service integration. -* :ref:`atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration` - experimental: Removes the settings that permit configuring one third-party service integration. -* :ref:`atlas-api-thirdPartyIntegrations-getThirdPartyIntegration` - experimental: Returns the settings for configuring integration with one third-party service. -* :ref:`atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations` - experimental: Returns the settings that permit integrations with all configured third-party services. -* :ref:`atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration` - experimental: Updates the settings for configuring integration with one third-party service. +* :ref:`atlas-api-thirdPartyIntegrations-createThirdPartyIntegration` - `experimental `: Adds the settings for configuring one third-party service integration. +* :ref:`atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration` - `experimental `: Removes the settings that permit configuring one third-party service integration. +* :ref:`atlas-api-thirdPartyIntegrations-getThirdPartyIntegration` - `experimental `: Returns the settings for configuring integration with one third-party service. +* :ref:`atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations` - `experimental `: Returns the settings that permit integrations with all configured third-party services. +* :ref:`atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration` - `experimental `: 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 912316dc9f..53e0d072e5 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 -experimental: Generates one X.509 certificate for the specified MongoDB user. +`experimental `: Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting API Key must have the Project Owner role. To get MongoDB Cloud to generate a managed certificate for a database user, set "x509Type" : "MANAGED" on the desired MongoDB Database User. If you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA. This command is invoking the endpoint with OperationID: 'createDatabaseUserCertificate'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/createDatabaseUserCertificate diff --git a/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt b/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt index 46c7e3550e..d35427b1c5 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 -experimental: Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. +`experimental `: 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. This command is invoking the endpoint with OperationID: 'disableCustomerManagedX509'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/disableCustomerManagedX509 diff --git a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt b/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt index 69d7472288..2dc17740a3 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 -experimental: Returns all unexpired X.509 certificates for the specified MongoDB user. +`experimental `: Returns all unexpired X.509 certificates for the specified MongoDB user. This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listDatabaseUserCertificates'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/listDatabaseUserCertificates diff --git a/docs/command/atlas-api-x509Authentication.txt b/docs/command/atlas-api-x509Authentication.txt index ce35dbd8ca..b7c4307072 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 -experimental: Returns, edits, and removes user-managed X.509 configurations. +`experimental `: 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 +51,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-x509Authentication-createDatabaseUserCertificate` - experimental: Generates one X.509 certificate for the specified MongoDB user. -* :ref:`atlas-api-x509Authentication-disableCustomerManagedX509` - experimental: 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` - experimental: Returns all unexpired X.509 certificates for the specified MongoDB user. +* :ref:`atlas-api-x509Authentication-createDatabaseUserCertificate` - `experimental `: Generates one X.509 certificate for the specified MongoDB user. +* :ref:`atlas-api-x509Authentication-disableCustomerManagedX509` - `experimental `: 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` - `experimental `: 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 ceddfd5050..95673a69f7 100644 --- a/docs/command/atlas-api.txt +++ b/docs/command/atlas-api.txt @@ -12,7 +12,7 @@ atlas api :depth: 1 :class: singlecol -experimental: Interact directly with any Atlas Admin API endpoint through the Atlas CLI, streamlining script development. +`experimental `: Interact directly with any Atlas Admin API endpoint through the Atlas CLI, streamlining script development. Options ------- @@ -49,58 +49,58 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-accessTracking` - experimental: Returns access logs for authentication attempts made to Atlas database deployments. -* :ref:`atlas-api-alertConfigurations` - experimental: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. -* :ref:`atlas-api-alerts` - experimental: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. -* :ref:`atlas-api-atlasSearch` - experimental: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. -* :ref:`atlas-api-auditing` - experimental: Returns and edits database auditing settings for MongoDB Cloud projects. -* :ref:`atlas-api-awsClustersDns` - experimental: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. -* :ref:`atlas-api-cloudBackups` - experimental: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. -* :ref:`atlas-api-cloudMigrationService` - experimental: Manages the Cloud Migration Service. -* :ref:`atlas-api-cloudProviderAccess` - experimental: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. -* :ref:`atlas-api-clusterOutageSimulation` - experimental: Returns, starts, or ends a cluster outage simulation. -* :ref:`atlas-api-clusters` - experimental: Returns, adds, edits, and removes database deployments. -* :ref:`atlas-api-collectionLevelMetrics` - experimental: Returns, adds, and edits pinned namespaces for the specified cluster or process. -* :ref:`atlas-api-customDatabaseRoles` - experimental: Returns, adds, edits, and removes custom database user privilege roles. -* :ref:`atlas-api-dataFederation` - experimental: Returns, adds, edits, and removes Federated Database Instances. -* :ref:`atlas-api-dataLakePipelines` - experimental: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. -* :ref:`atlas-api-databaseUsers` - experimental: Returns, adds, edits, and removes database users. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement` - experimental: Returns and edits the Encryption at Rest using Customer Key Management configuration. -* :ref:`atlas-api-events` - experimental: Returns events. -* :ref:`atlas-api-federatedAuthentication` - experimental: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. -* :ref:`atlas-api-flexClusters` - experimental: Returns, adds, edits, and removes flex clusters. -* :ref:`atlas-api-flexRestoreJobs` - experimental: Returns and adds restore jobs for flex database deployments. -* :ref:`atlas-api-flexSnapshots` - experimental: Returns and requests to download flex database deployment snapshots. -* :ref:`atlas-api-globalClusters` - experimental: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. -* :ref:`atlas-api-invoices` - experimental: Returns invoices. -* :ref:`atlas-api-ldapConfiguration` - experimental: Returns, edits, verifies, and removes LDAP configurations. -* :ref:`atlas-api-legacyBackup` - experimental: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. -* :ref:`atlas-api-maintenanceWindows` - experimental: Returns, edits, and removes maintenance windows. -* :ref:`atlas-api-mongoDbCloudUsers` - experimental: Returns, adds, and edits MongoDB Cloud users. -* :ref:`atlas-api-monitoringAndLogs` - experimental: Returns database deployment monitoring and logging data. -* :ref:`atlas-api-networkPeering` - experimental: Returns, adds, edits, and removes network peering containers and peering connections. -* :ref:`atlas-api-onlineArchive` - experimental: Returns, adds, edits, or removes an online archive. -* :ref:`atlas-api-openApi` - experimental: Returns information about the MongoDB Atlas Specification. -* :ref:`atlas-api-organizations` - experimental: Returns, adds, and edits organizational units in MongoDB Cloud. -* :ref:`atlas-api-performanceAdvisor` - experimental: Returns suggested indexes and slow query data for a database deployment. -* :ref:`atlas-api-privateEndpointServices` - experimental: Returns, adds, edits, and removes private endpoint services. -* :ref:`atlas-api-programmaticApiKeys` - experimental: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. -* :ref:`atlas-api-projectIpAccessList` - experimental: Returns, adds, edits, and removes network access limits to database deployments in Atlas. -* :ref:`atlas-api-projects` - experimental: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. -* :ref:`atlas-api-pushBasedLogExport` - experimental: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. -* :ref:`atlas-api-resourcePolicies` - experimental: Configure and manage Atlas Resource Policies within your organization. -* :ref:`atlas-api-rollingIndex` - experimental: Creates one index to a database deployment in a rolling manner. -* :ref:`atlas-api-root` - experimental: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. -* :ref:`atlas-api-serverlessInstances` - experimental: Returns, adds, edits, and removes serverless instances. -* :ref:`atlas-api-serverlessPrivateEndpoints` - experimental: Returns, adds, edits, and removes private endpoints for serverless instances. -* :ref:`atlas-api-serviceAccounts` - experimental: Endpoints for managing Service Accounts and secrets. -* :ref:`atlas-api-sharedTierRestoreJobs` - experimental: Returns and adds restore jobs for shared-tier database deployments. -* :ref:`atlas-api-sharedTierSnapshots` - experimental: Returns and requests to download shared-tier database deployment snapshots. -* :ref:`atlas-api-streams` - experimental: Returns, adds, edits, and removes Streams Instances. -* :ref:`atlas-api-teams` - experimental: Returns, adds, edits, or removes teams. -* :ref:`atlas-api-test` - experimental: Atlas test endpoints. -* :ref:`atlas-api-thirdPartyIntegrations` - experimental: Returns, adds, edits, and removes third-party service integration configurations. -* :ref:`atlas-api-x509Authentication` - experimental: Returns, edits, and removes user-managed X.509 configurations. +* :ref:`atlas-api-accessTracking` - `experimental `: Returns access logs for authentication attempts made to Atlas database deployments. +* :ref:`atlas-api-alertConfigurations` - `experimental `: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. +* :ref:`atlas-api-alerts` - `experimental `: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. +* :ref:`atlas-api-atlasSearch` - `experimental `: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. +* :ref:`atlas-api-auditing` - `experimental `: Returns and edits database auditing settings for MongoDB Cloud projects. +* :ref:`atlas-api-awsClustersDns` - `experimental `: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. +* :ref:`atlas-api-cloudBackups` - `experimental `: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. +* :ref:`atlas-api-cloudMigrationService` - `experimental `: Manages the Cloud Migration Service. +* :ref:`atlas-api-cloudProviderAccess` - `experimental `: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. +* :ref:`atlas-api-clusterOutageSimulation` - `experimental `: Returns, starts, or ends a cluster outage simulation. +* :ref:`atlas-api-clusters` - `experimental `: Returns, adds, edits, and removes database deployments. +* :ref:`atlas-api-collectionLevelMetrics` - `experimental `: Returns, adds, and edits pinned namespaces for the specified cluster or process. +* :ref:`atlas-api-customDatabaseRoles` - `experimental `: Returns, adds, edits, and removes custom database user privilege roles. +* :ref:`atlas-api-dataFederation` - `experimental `: Returns, adds, edits, and removes Federated Database Instances. +* :ref:`atlas-api-dataLakePipelines` - `experimental `: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. +* :ref:`atlas-api-databaseUsers` - `experimental `: Returns, adds, edits, and removes database users. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement` - `experimental `: Returns and edits the Encryption at Rest using Customer Key Management configuration. +* :ref:`atlas-api-events` - `experimental `: Returns events. +* :ref:`atlas-api-federatedAuthentication` - `experimental `: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. +* :ref:`atlas-api-flexClusters` - `experimental `: Returns, adds, edits, and removes flex clusters. +* :ref:`atlas-api-flexRestoreJobs` - `experimental `: Returns and adds restore jobs for flex database deployments. +* :ref:`atlas-api-flexSnapshots` - `experimental `: Returns and requests to download flex database deployment snapshots. +* :ref:`atlas-api-globalClusters` - `experimental `: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. +* :ref:`atlas-api-invoices` - `experimental `: Returns invoices. +* :ref:`atlas-api-ldapConfiguration` - `experimental `: Returns, edits, verifies, and removes LDAP configurations. +* :ref:`atlas-api-legacyBackup` - `experimental `: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. +* :ref:`atlas-api-maintenanceWindows` - `experimental `: Returns, edits, and removes maintenance windows. +* :ref:`atlas-api-mongoDbCloudUsers` - `experimental `: Returns, adds, and edits MongoDB Cloud users. +* :ref:`atlas-api-monitoringAndLogs` - `experimental `: Returns database deployment monitoring and logging data. +* :ref:`atlas-api-networkPeering` - `experimental `: Returns, adds, edits, and removes network peering containers and peering connections. +* :ref:`atlas-api-onlineArchive` - `experimental `: Returns, adds, edits, or removes an online archive. +* :ref:`atlas-api-openApi` - `experimental `: Returns information about the MongoDB Atlas Specification. +* :ref:`atlas-api-organizations` - `experimental `: Returns, adds, and edits organizational units in MongoDB Cloud. +* :ref:`atlas-api-performanceAdvisor` - `experimental `: Returns suggested indexes and slow query data for a database deployment. +* :ref:`atlas-api-privateEndpointServices` - `experimental `: Returns, adds, edits, and removes private endpoint services. +* :ref:`atlas-api-programmaticApiKeys` - `experimental `: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. +* :ref:`atlas-api-projectIpAccessList` - `experimental `: Returns, adds, edits, and removes network access limits to database deployments in Atlas. +* :ref:`atlas-api-projects` - `experimental `: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. +* :ref:`atlas-api-pushBasedLogExport` - `experimental `: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. +* :ref:`atlas-api-resourcePolicies` - `experimental `: Configure and manage Atlas Resource Policies within your organization. +* :ref:`atlas-api-rollingIndex` - `experimental `: Creates one index to a database deployment in a rolling manner. +* :ref:`atlas-api-root` - `experimental `: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. +* :ref:`atlas-api-serverlessInstances` - `experimental `: Returns, adds, edits, and removes serverless instances. +* :ref:`atlas-api-serverlessPrivateEndpoints` - `experimental `: Returns, adds, edits, and removes private endpoints for serverless instances. +* :ref:`atlas-api-serviceAccounts` - `experimental `: Endpoints for managing Service Accounts and secrets. +* :ref:`atlas-api-sharedTierRestoreJobs` - `experimental `: Returns and adds restore jobs for shared-tier database deployments. +* :ref:`atlas-api-sharedTierSnapshots` - `experimental `: Returns and requests to download shared-tier database deployment snapshots. +* :ref:`atlas-api-streams` - `experimental `: Returns, adds, edits, and removes Streams Instances. +* :ref:`atlas-api-teams` - `experimental `: Returns, adds, edits, or removes teams. +* :ref:`atlas-api-test` - `experimental `: Atlas test endpoints. +* :ref:`atlas-api-thirdPartyIntegrations` - `experimental `: Returns, adds, edits, and removes third-party service integration configurations. +* :ref:`atlas-api-x509Authentication` - `experimental `: Returns, edits, and removes user-managed X.509 configurations. .. toctree:: diff --git a/docs/command/atlas.txt b/docs/command/atlas.txt index 2331b90ce4..7478b30a0a 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` - experimental: Interact directly with any Atlas Admin API endpoint through the Atlas CLI, streamlining script development. +* :ref:`atlas-api` - `experimental `: Interact directly with any Atlas Admin API endpoint through the Atlas CLI, streamlining script development. * :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/tools/docs/main.go b/tools/docs/main.go index 829b337f87..48feffc8e7 100644 --- a/tools/docs/main.go +++ b/tools/docs/main.go @@ -48,7 +48,7 @@ func addExperimenalToAPICommands(cmd *cobra.Command) { } func markExperimentalRecursively(cmd *cobra.Command) { - cmd.Short = "experimental: " + cmd.Short + cmd.Short = "`experimental `: " + cmd.Short for _, subCommand := range cmd.Commands() { markExperimentalRecursively(subCommand) From e194dc3cd93680c2088a9940f98d23caad23d643 Mon Sep 17 00:00:00 2001 From: Jeroen Vervaeke Date: Thu, 30 Jan 2025 16:44:22 +0000 Subject: [PATCH 4/4] Added _ --- ...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 +- .../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 +- ...sters-upgradeSharedClusterToServerless.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 +- ...ngoDbCloudUsers-removeOrganizationRole.txt | 2 +- ...pi-mongoDbCloudUsers-removeProjectRole.txt | 2 +- ...i-mongoDbCloudUsers-removeUserFromTeam.txt | 2 +- ...ngoDbCloudUsers-updateOrganizationUser.txt | 2 +- docs/command/atlas-api-mongoDbCloudUsers.txt | 30 ++--- ...-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 +-- .../atlas-api-openApi-getApiVersions.txt | 2 +- .../atlas-api-openApi-getOpenApiInfo.txt | 2 +- docs/command/atlas-api-openApi.txt | 6 +- ...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 +- ...pi-organizations-listOrganizationUsers.txt | 2 +- ...as-api-organizations-listOrganizations.txt | 2 +- ...i-organizations-removeOrganizationUser.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 | 36 +++--- ...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-listProjectUsers.txt | 2 +- .../atlas-api-projects-listProjects.txt | 2 +- ...pi-projects-migrateProjectToAnotherOrg.txt | 2 +- .../atlas-api-projects-removeProjectUser.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 | 52 ++++----- ...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 +- ...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 +- .../atlas-api-streams-stopStreamProcessor.txt | 2 +- ...las-api-streams-updateStreamConnection.txt | 2 +- ...atlas-api-streams-updateStreamInstance.txt | 2 +- docs/command/atlas-api-streams.txt | 58 +++++----- .../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 +- .../command/atlas-api-teams-listTeamUsers.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 | 28 ++--- .../atlas-api-test-versionedExample.txt | 2 +- docs/command/atlas-api-test.txt | 4 +- ...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 | 106 +++++++++--------- docs/command/atlas.txt | 2 +- tools/docs/main.go | 2 +- 508 files changed, 1013 insertions(+), 1013 deletions(-) diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt index e53aaeba19..7c1fc9a77b 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 -`experimental `: Returns the access logs of one cluster identified by the cluster's name. +`experimental `_: Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. This command is invoking the endpoint with OperationID: 'listAccessLogsByClusterName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName diff --git a/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt b/docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt index a9807476c5..ab604520c2 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 -`experimental `: Returns the access logs of one cluster identified by the cluster's hostname. +`experimental `_: Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. This command is invoking the endpoint with OperationID: 'listAccessLogsByHostname'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname diff --git a/docs/command/atlas-api-accessTracking.txt b/docs/command/atlas-api-accessTracking.txt index 41d9ef1dba..f69a7a0f98 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 -`experimental `: Returns access logs for authentication attempts made to Atlas database deployments. +`experimental `_: 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 +51,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - `experimental `: Returns the access logs of one cluster identified by the cluster's name. -* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - `experimental `: Returns the access logs of one cluster identified by the cluster's hostname. +* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - `experimental `_: Returns the access logs of one cluster identified by the cluster's name. +* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - `experimental `_: 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 66eb019537..423ee91a54 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 -`experimental `: Creates one alert configuration for the specified project. +`experimental `_: Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'createAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createAlertConfiguration diff --git a/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt index dcf8f58f73..cf72996d87 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 -`experimental `: Removes one alert configuration from the specified project. +`experimental `_: Removes one alert configuration from the specified project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'deleteAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/deleteAlertConfiguration diff --git a/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt index 0fe11e3203..bb6f8f36b4 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 -`experimental `: Returns the specified alert configuration from the specified project. +`experimental `_: Returns the specified alert configuration from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'getAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getAlertConfiguration diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames.txt index d4170b9c69..0c419993a7 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 -`experimental `: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'listAlertConfigurationMatchersFieldNames'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationMatchersFieldNames diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurations.txt index d0206996ae..97b00b312b 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 -`experimental `: Returns all alert configurations for one project. +`experimental `_: Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlertConfigurations'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations diff --git a/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt b/docs/command/atlas-api-alertConfigurations-listAlertConfigurationsByAlertId.txt index 22b66b79ef..0234a5d1f6 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 -`experimental `: Returns all alert configurations set for the specified alert. +`experimental `_: Returns all alert configurations set for the specified alert. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlertConfigurationsByAlertId'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationsByAlertId diff --git a/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt index 2f3345a1c7..34ccb81a86 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 -`experimental `: Enables or disables the specified alert configuration in the specified project. +`experimental `_: Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. NOTE: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see Update One Alert Configuration. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'toggleAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration diff --git a/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt b/docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt index bcf105d83f..e6ca80baca 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 -`experimental `: Updates one alert configuration in the specified project. +`experimental `_: Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. NOTE: To enable or disable the alert configuration, see Toggle One State of One Alert Configuration in One Project. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'updateAlertConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateAlertConfiguration diff --git a/docs/command/atlas-api-alertConfigurations.txt b/docs/command/atlas-api-alertConfigurations.txt index 315f6704f2..32b9c016a7 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 -`experimental `: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. +`experimental `_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change. @@ -51,14 +51,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - `experimental `: Creates one alert configuration for the specified project. -* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - `experimental `: Removes one alert configuration from the specified project. -* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - `experimental `: Returns the specified alert configuration from the specified project. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - `experimental `: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - `experimental `: Returns all alert configurations for one project. -* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - `experimental `: Returns all alert configurations set for the specified alert. -* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - `experimental `: Enables or disables the specified alert configuration in the specified project. -* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - `experimental `: Updates one alert configuration in the specified project. +* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - `experimental `_: Creates one alert configuration for the specified project. +* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - `experimental `_: Removes one alert configuration from the specified project. +* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - `experimental `_: Returns the specified alert configuration from the specified project. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - `experimental `_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - `experimental `_: Returns all alert configurations for one project. +* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - `experimental `_: Returns all alert configurations set for the specified alert. +* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - `experimental `_: Enables or disables the specified alert configuration in the specified project. +* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - `experimental `_: 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 1cd30f3b8c..c7c18d7238 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 -`experimental `: Confirms receipt of one existing alert. +`experimental `_: Confirms receipt of one existing alert. This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'acknowledgeAlert'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeAlert diff --git a/docs/command/atlas-api-alerts-getAlert.txt b/docs/command/atlas-api-alerts-getAlert.txt index 3cb47463cf..73296017d3 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 -`experimental `: Returns one alert. +`experimental `_: Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'getAlert'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getAlert diff --git a/docs/command/atlas-api-alerts-listAlerts.txt b/docs/command/atlas-api-alerts-listAlerts.txt index 101d3b4b8d..c9abf87e1b 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 -`experimental `: Returns all alerts. +`experimental `_: Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlerts'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts diff --git a/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt b/docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt index 6aa5aef04c..137b3d78ba 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 -`experimental `: Returns all open alerts that the specified alert configuration triggers. +`experimental `_: Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listAlertsByAlertConfigurationId'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlertsByAlertConfigurationId diff --git a/docs/command/atlas-api-alerts.txt b/docs/command/atlas-api-alerts.txt index 108e2a02eb..86d682915b 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 -`experimental `: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. +`experimental `_: 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 +51,10 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-alerts-acknowledgeAlert` - `experimental `: Confirms receipt of one existing alert. -* :ref:`atlas-api-alerts-getAlert` - `experimental `: Returns one alert. -* :ref:`atlas-api-alerts-listAlerts` - `experimental `: Returns all alerts. -* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - `experimental `: Returns all open alerts that the specified alert configuration triggers. +* :ref:`atlas-api-alerts-acknowledgeAlert` - `experimental `_: Confirms receipt of one existing alert. +* :ref:`atlas-api-alerts-getAlert` - `experimental `_: Returns one alert. +* :ref:`atlas-api-alerts-listAlerts` - `experimental `_: Returns all alerts. +* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - `experimental `_: 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 c78d39377d..e5014715eb 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 -`experimental `: Creates Search Nodes for the specified cluster. +`experimental `_: Creates Search Nodes for the specified cluster. This command is invoking the endpoint with OperationID: 'createAtlasSearchDeployment'. For more information about flags, format of --file and examples, see: 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 a7a1ca4a8a..1f357c2804 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 -`experimental `: Creates one Atlas Search index on the specified collection. +`experimental `_: Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'createAtlasSearchIndex'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndex diff --git a/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt index 092ef4c475..47996fddd6 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 -`experimental `: Creates one Atlas Search index on the specified collection. +`experimental `_: Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'createAtlasSearchIndexDeprecated'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndexDeprecated diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchDeployment.txt index 43c1998dae..68982779cf 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 -`experimental `: Deletes the Search Nodes for the specified cluster. +`experimental `_: Deletes the Search Nodes for the specified cluster. This command is invoking the endpoint with OperationID: 'deleteAtlasSearchDeployment'. For more information about flags, format of --file and examples, see: 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 71aa7402c8..ecf3b120c9 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 -`experimental `: Removes one Atlas Search index that you identified with its unique ID. +`experimental `_: Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent. This command is invoking the endpoint with OperationID: 'deleteAtlasSearchIndex'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndex diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexByName.txt index ce9646df5e..e0d762226e 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 -`experimental `: Removes one Atlas Search index that you identified with its database, collection, and name. +`experimental `_: Removes one Atlas Search index that you identified with its database, collection, and name. To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent. This command is invoking the endpoint with OperationID: 'deleteAtlasSearchIndexByName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexByName diff --git a/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated.txt index dc8fd8242f..6d5a491cda 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 -`experimental `: Removes one Atlas Search index that you identified with its unique ID. +`experimental `_: Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'deleteAtlasSearchIndexDeprecated'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexDeprecated diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchDeployment.txt index a92b007698..24f6d7c522 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 -`experimental `: Return the Search Nodes for the specified cluster. +`experimental `_: Return the Search Nodes for the specified cluster. This command is invoking the endpoint with OperationID: 'getAtlasSearchDeployment'. For more information about flags, format of --file and examples, see: 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 2d373a595e..04ac99361a 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 -`experimental `: Returns one Atlas Search index in the specified project. +`experimental `_: Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'getAtlasSearchIndex'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndex diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexByName.txt index a5e4862948..c98133465c 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 -`experimental `: Returns one Atlas Search index in the specified project. +`experimental `_: Returns one Atlas Search index in the specified project. You identify this index using its database, collection and name. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'getAtlasSearchIndexByName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexByName diff --git a/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-getAtlasSearchIndexDeprecated.txt index 8e3e047931..e1db424f3a 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 -`experimental `: Returns one Atlas Search index in the specified project. +`experimental `_: Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'getAtlasSearchIndexDeprecated'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexDeprecated diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexes.txt index 02015cb811..03b5dc5100 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 -`experimental `: Returns all Atlas Search indexes on the specified collection. +`experimental `_: Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'listAtlasSearchIndexes'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexes diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesCluster.txt index e66817faf4..bdd5d6574c 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 -`experimental `: Returns all Atlas Search indexes on the specified cluster. +`experimental `_: Returns all Atlas Search indexes on the specified cluster. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'listAtlasSearchIndexesCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesCluster diff --git a/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt b/docs/command/atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated.txt index ea566c2bc1..97c8ab5ec3 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 -`experimental `: Returns all Atlas Search indexes on the specified collection. +`experimental `_: Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'listAtlasSearchIndexesDeprecated'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesDeprecated diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt index c26c1db20c..ad8446788a 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 -`experimental `: Updates the Search Nodes for the specified cluster. +`experimental `_: Updates the Search Nodes for the specified cluster. This command is invoking the endpoint with OperationID: 'updateAtlasSearchDeployment'. For more information about flags, format of --file and examples, see: 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 6ce0efff30..e65a04a779 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 -`experimental `: Updates one Atlas Search index that you identified with its unique ID. +`experimental `_: Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'updateAtlasSearchIndex'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndex diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt index 464e95b189..0d4c9dee2a 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 -`experimental `: Updates one Atlas Search index that you identified with its database, collection name, and index name. +`experimental `_: Updates one Atlas Search index that you identified with its database, collection name, and index name. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'updateAtlasSearchIndexByName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexByName diff --git a/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt b/docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt index 36ffaa6c0a..487105ecee 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 -`experimental `: Updates one Atlas Search index that you identified with its unique ID. +`experimental `_: Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'updateAtlasSearchIndexDeprecated'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexDeprecated diff --git a/docs/command/atlas-api-atlasSearch.txt b/docs/command/atlas-api-atlasSearch.txt index c1832cbbc2..5217f9763d 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 -`experimental `: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. +`experimental `_: 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 +51,24 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-atlasSearch-createAtlasSearchDeployment` - `experimental `: Creates Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-createAtlasSearchIndex` - `experimental `: Creates one Atlas Search index on the specified collection. -* :ref:`atlas-api-atlasSearch-createAtlasSearchIndexDeprecated` - `experimental `: Creates one Atlas Search index on the specified collection. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchDeployment` - `experimental `: Deletes the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndex` - `experimental `: Removes one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexByName` - `experimental `: Removes one Atlas Search index that you identified with its database, collection, and name. -* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated` - `experimental `: Removes one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-getAtlasSearchDeployment` - `experimental `: Return the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndex` - `experimental `: Returns one Atlas Search index in the specified project. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexByName` - `experimental `: Returns one Atlas Search index in the specified project. -* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexDeprecated` - `experimental `: Returns one Atlas Search index in the specified project. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexes` - `experimental `: Returns all Atlas Search indexes on the specified collection. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesCluster` - `experimental `: Returns all Atlas Search indexes on the specified cluster. -* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated` - `experimental `: Returns all Atlas Search indexes on the specified collection. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchDeployment` - `experimental `: Updates the Search Nodes for the specified cluster. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndex` - `experimental `: Updates one Atlas Search index that you identified with its unique ID. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexByName` - `experimental `: Updates one Atlas Search index that you identified with its database, collection name, and index name. -* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated` - `experimental `: Updates one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-createAtlasSearchDeployment` - `experimental `_: Creates Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-createAtlasSearchIndex` - `experimental `_: Creates one Atlas Search index on the specified collection. +* :ref:`atlas-api-atlasSearch-createAtlasSearchIndexDeprecated` - `experimental `_: Creates one Atlas Search index on the specified collection. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchDeployment` - `experimental `_: Deletes the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndex` - `experimental `_: Removes one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexByName` - `experimental `_: Removes one Atlas Search index that you identified with its database, collection, and name. +* :ref:`atlas-api-atlasSearch-deleteAtlasSearchIndexDeprecated` - `experimental `_: Removes one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-getAtlasSearchDeployment` - `experimental `_: Return the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndex` - `experimental `_: Returns one Atlas Search index in the specified project. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexByName` - `experimental `_: Returns one Atlas Search index in the specified project. +* :ref:`atlas-api-atlasSearch-getAtlasSearchIndexDeprecated` - `experimental `_: Returns one Atlas Search index in the specified project. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexes` - `experimental `_: Returns all Atlas Search indexes on the specified collection. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesCluster` - `experimental `_: Returns all Atlas Search indexes on the specified cluster. +* :ref:`atlas-api-atlasSearch-listAtlasSearchIndexesDeprecated` - `experimental `_: Returns all Atlas Search indexes on the specified collection. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchDeployment` - `experimental `_: Updates the Search Nodes for the specified cluster. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndex` - `experimental `_: Updates one Atlas Search index that you identified with its unique ID. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexByName` - `experimental `_: Updates one Atlas Search index that you identified with its database, collection name, and index name. +* :ref:`atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated` - `experimental `_: 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 95f9d1a8a4..3af5b6e529 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 -`experimental `: Returns the auditing configuration for the specified project. +`experimental `_: Returns the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. This command is invoking the endpoint with OperationID: 'getAuditingConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/getAuditingConfiguration diff --git a/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt b/docs/command/atlas-api-auditing-updateAuditingConfiguration.txt index 8ec25dc127..9bb6313de8 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 -`experimental `: Updates the auditing configuration for the specified project. +`experimental `_: Updates the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting API Key must have the Project Owner role. This feature isn't available for M0, M2, M5, or serverless clusters. This command is invoking the endpoint with OperationID: 'updateAuditingConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/updateAuditingConfiguration diff --git a/docs/command/atlas-api-auditing.txt b/docs/command/atlas-api-auditing.txt index 96ee155750..b67c11ae20 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 -`experimental `: Returns and edits database auditing settings for MongoDB Cloud projects. +`experimental `_: Returns and edits database auditing settings for MongoDB Cloud projects. Options ------- @@ -49,8 +49,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-auditing-getAuditingConfiguration` - `experimental `: Returns the auditing configuration for the specified project. -* :ref:`atlas-api-auditing-updateAuditingConfiguration` - `experimental `: Updates the auditing configuration for the specified project. +* :ref:`atlas-api-auditing-getAuditingConfiguration` - `experimental `_: Returns the auditing configuration for the specified project. +* :ref:`atlas-api-auditing-updateAuditingConfiguration` - `experimental `_: 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 21e93d645f..284e98a498 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 -`experimental `: Returns the custom DNS configuration for AWS clusters in the specified project. +`experimental `_: Returns the custom DNS configuration for AWS clusters in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getAwsCustomDns'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/getAwsCustomDns diff --git a/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt b/docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt index 684983de3e..a40f6e9800 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 -`experimental `: Enables or disables the custom DNS configuration for AWS clusters in the specified project. +`experimental `_: Enables or disables the custom DNS configuration for AWS clusters in the specified project. Enable custom DNS if you use AWS VPC peering and use your own DNS servers. To use this resource, the requesting API Key must have the Project Atlas Admin role. This command is invoking the endpoint with OperationID: 'toggleAwsCustomDns'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/toggleAwsCustomDns diff --git a/docs/command/atlas-api-awsClustersDns.txt b/docs/command/atlas-api-awsClustersDns.txt index 682309b4b9..070334044d 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 -`experimental `: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. +`experimental `_: 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 +51,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-awsClustersDns-getAwsCustomDns` - `experimental `: Returns the custom DNS configuration for AWS clusters in the specified project. -* :ref:`atlas-api-awsClustersDns-toggleAwsCustomDns` - `experimental `: Enables or disables the custom DNS configuration for AWS clusters in the specified project. +* :ref:`atlas-api-awsClustersDns-getAwsCustomDns` - `experimental `_: Returns the custom DNS configuration for AWS clusters in the specified project. +* :ref:`atlas-api-awsClustersDns-toggleAwsCustomDns` - `experimental `_: 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 3aa5fe0b80..2356491be4 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 -`experimental `: Cancels one cloud backup restore job of one cluster from the specified project. +`experimental `_: Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'cancelBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelBackupRestoreJob diff --git a/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-createBackupExportJob.txt index c948a9bd79..cd54e51c1b 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 -`experimental `: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. +`experimental `_: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role. This command is invoking the endpoint with OperationID: 'createBackupExportJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupExportJob diff --git a/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt index 3f1a59afbe..bdc0bff413 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 -`experimental `: Restores one snapshot of one cluster from the specified project. +`experimental `_: Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupRestoreJob diff --git a/docs/command/atlas-api-cloudBackups-createExportBucket.txt b/docs/command/atlas-api-cloudBackups-createExportBucket.txt index b3863cf06f..be3c3fd938 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 -`experimental `: Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. +`experimental `_: Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createExportBucket'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createExportBucket diff --git a/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt index 59a96ee9dd..49e9fd41ab 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 -`experimental `: Restores one snapshot of one serverless instance from the specified project. +`experimental `_: Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createServerlessBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createServerlessBackupRestoreJob diff --git a/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt b/docs/command/atlas-api-cloudBackups-deleteAllBackupSchedules.txt index 4546e09369..29fafa3994 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 -`experimental `: Removes all cloud backup schedules for the specified cluster. +`experimental `_: Removes all cloud backup schedules for the specified cluster. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Atlas Admin role. This command is invoking the endpoint with OperationID: 'deleteAllBackupSchedules'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteAllBackupSchedules diff --git a/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt b/docs/command/atlas-api-cloudBackups-deleteExportBucket.txt index 978bfda40b..8faed32156 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 -`experimental `: Deletes an Export Bucket. +`experimental `_: Deletes an Export Bucket. Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteExportBucket'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteExportBucket diff --git a/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-deleteReplicaSetBackup.txt index 72a1f14086..0c84650530 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 -`experimental `: Removes the specified snapshot. +`experimental `_: Removes the specified snapshot. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteReplicaSetBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteReplicaSetBackup diff --git a/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-deleteShardedClusterBackup.txt index 3d67df6d0c..1380f49a25 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 -`experimental `: Removes one snapshot of one sharded cluster from the specified project. +`experimental `_: Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteShardedClusterBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteShardedClusterBackup diff --git a/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-disableDataProtectionSettings.txt index 1aaff5d3be..becc5aa619 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 -`experimental `: Disables the Backup Compliance Policy settings with the specified project. +`experimental `_: 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 API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'disableDataProtectionSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/disableDataProtectionSettings diff --git a/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt b/docs/command/atlas-api-cloudBackups-getBackupExportJob.txt index 0c9b7c617d..333f35331a 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 -`experimental `: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. +`experimental `_: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. This command is invoking the endpoint with OperationID: 'getBackupExportJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupExportJob diff --git a/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getBackupRestoreJob.txt index 0bedb0b021..0cb9481a01 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 -`experimental `: Returns one cloud backup restore job for one cluster from the specified project. +`experimental `_: Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupRestoreJob diff --git a/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-getBackupSchedule.txt index 2366c90636..839ab346ba 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 -`experimental `: Returns the cloud backup schedule for the specified cluster within the specified project. +`experimental `_: Returns the cloud backup schedule for the specified cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getBackupSchedule'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupSchedule diff --git a/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-getDataProtectionSettings.txt index e01a9e4f8b..8c1c69b971 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 -`experimental `: Returns the Backup Compliance Policy settings with the specified project. +`experimental `_: Returns the Backup Compliance Policy settings with the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getDataProtectionSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getDataProtectionSettings diff --git a/docs/command/atlas-api-cloudBackups-getExportBucket.txt b/docs/command/atlas-api-cloudBackups-getExportBucket.txt index 8d1edd4ed1..47fea9272a 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 -`experimental `: Returns one Export Bucket associated with the specified Project. +`experimental `_: Returns one Export Bucket associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getExportBucket'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getExportBucket diff --git a/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt b/docs/command/atlas-api-cloudBackups-getReplicaSetBackup.txt index 88deeb775d..5359d6b3b9 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 -`experimental `: Returns one snapshot from the specified cluster. +`experimental `_: Returns one snapshot from the specified cluster. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getReplicaSetBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getReplicaSetBackup diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackup.txt index 746d113ca5..e4f8220af0 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 -`experimental `: Returns one snapshot of one serverless instance from the specified project. +`experimental `_: Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getServerlessBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackup diff --git a/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt b/docs/command/atlas-api-cloudBackups-getServerlessBackupRestoreJob.txt index 3f7f351700..3befa8589c 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 -`experimental `: Returns one restore job for one serverless instance from the specified project. +`experimental `_: Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getServerlessBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackupRestoreJob diff --git a/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt b/docs/command/atlas-api-cloudBackups-getShardedClusterBackup.txt index 024d3d5453..7d26211c14 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 -`experimental `: Returns one snapshot of one sharded cluster from the specified project. +`experimental `_: Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getShardedClusterBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getShardedClusterBackup diff --git a/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupExportJobs.txt index f72c6d1aac..7dad1bdf48 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 -`experimental `: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. +`experimental `_: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. This command is invoking the endpoint with OperationID: 'listBackupExportJobs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupExportJobs diff --git a/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listBackupRestoreJobs.txt index 841e7f6cf1..6104b342c3 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 -`experimental `: Returns all cloud backup restore jobs for one cluster from the specified project. +`experimental `_: Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'listBackupRestoreJobs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupRestoreJobs diff --git a/docs/command/atlas-api-cloudBackups-listExportBuckets.txt b/docs/command/atlas-api-cloudBackups-listExportBuckets.txt index de9aee6c8c..d08fcd478c 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 -`experimental `: Returns all Export Buckets associated with the specified Project. +`experimental `_: Returns all Export Buckets associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listExportBuckets'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listExportBuckets diff --git a/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt b/docs/command/atlas-api-cloudBackups-listReplicaSetBackups.txt index 82e987577a..ff3678a553 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 -`experimental `: Returns all snapshots of one cluster from the specified project. +`experimental `_: Returns all snapshots of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listReplicaSetBackups'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listReplicaSetBackups diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackupRestoreJobs.txt index 147798dc35..e374cb3d1f 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 -`experimental `: Returns all restore jobs for one serverless instance from the specified project. +`experimental `_: Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'listServerlessBackupRestoreJobs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackupRestoreJobs diff --git a/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt b/docs/command/atlas-api-cloudBackups-listServerlessBackups.txt index 4d05c2e91f..628c9f7309 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 -`experimental `: Returns all snapshots of one serverless instance from the specified project. +`experimental `_: Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listServerlessBackups'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackups diff --git a/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt b/docs/command/atlas-api-cloudBackups-listShardedClusterBackups.txt index debf66011f..d471a92046 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 -`experimental `: Returns all snapshots of one sharded cluster from the specified project. +`experimental `_: Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listShardedClusterBackups'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listShardedClusterBackups diff --git a/docs/command/atlas-api-cloudBackups-takeSnapshot.txt b/docs/command/atlas-api-cloudBackups-takeSnapshot.txt index f33589afb3..3adde2f614 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 -`experimental `: Takes one on-demand snapshot for the specified cluster. +`experimental `_: Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'takeSnapshot'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/takeSnapshot diff --git a/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt b/docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt index a2b34d842f..4ee4e9a794 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 -`experimental `: Updates the cloud backup schedule for one cluster within the specified project. +`experimental `_: Updates the cloud backup schedule for one cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateBackupSchedule'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateBackupSchedule diff --git a/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt b/docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt index 578461e383..0d6832f429 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 -`experimental `: Updates the Backup Compliance Policy settings for the specified project. +`experimental `_: Updates the Backup Compliance Policy settings for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateDataProtectionSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateDataProtectionSettings diff --git a/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt b/docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt index 2120bb7f97..b5f814db2a 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 -`experimental `: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +`experimental `_: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. This command is invoking the endpoint with OperationID: 'updateSnapshotRetention'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateSnapshotRetention diff --git a/docs/command/atlas-api-cloudBackups.txt b/docs/command/atlas-api-cloudBackups.txt index 42643d4dbd..34dd6e7f2e 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 -`experimental `: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. +`experimental `_: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups. @@ -51,36 +51,36 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudBackups-cancelBackupRestoreJob` - `experimental `: Cancels one cloud backup restore job of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-createBackupExportJob` - `experimental `: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. -* :ref:`atlas-api-cloudBackups-createBackupRestoreJob` - `experimental `: Restores one snapshot of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-createExportBucket` - `experimental `: Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. -* :ref:`atlas-api-cloudBackups-createServerlessBackupRestoreJob` - `experimental `: Restores one snapshot of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-deleteAllBackupSchedules` - `experimental `: Removes all cloud backup schedules for the specified cluster. -* :ref:`atlas-api-cloudBackups-deleteExportBucket` - `experimental `: Deletes an Export Bucket. -* :ref:`atlas-api-cloudBackups-deleteReplicaSetBackup` - `experimental `: Removes the specified snapshot. -* :ref:`atlas-api-cloudBackups-deleteShardedClusterBackup` - `experimental `: Removes one snapshot of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-disableDataProtectionSettings` - `experimental `: Disables the Backup Compliance Policy settings with the specified project. -* :ref:`atlas-api-cloudBackups-getBackupExportJob` - `experimental `: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. -* :ref:`atlas-api-cloudBackups-getBackupRestoreJob` - `experimental `: Returns one cloud backup restore job for one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-getBackupSchedule` - `experimental `: Returns the cloud backup schedule for the specified cluster within the specified project. -* :ref:`atlas-api-cloudBackups-getDataProtectionSettings` - `experimental `: Returns the Backup Compliance Policy settings with the specified project. -* :ref:`atlas-api-cloudBackups-getExportBucket` - `experimental `: Returns one Export Bucket associated with the specified Project. -* :ref:`atlas-api-cloudBackups-getReplicaSetBackup` - `experimental `: Returns one snapshot from the specified cluster. -* :ref:`atlas-api-cloudBackups-getServerlessBackup` - `experimental `: Returns one snapshot of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-getServerlessBackupRestoreJob` - `experimental `: Returns one restore job for one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-getShardedClusterBackup` - `experimental `: Returns one snapshot of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listBackupExportJobs` - `experimental `: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. -* :ref:`atlas-api-cloudBackups-listBackupRestoreJobs` - `experimental `: Returns all cloud backup restore jobs for one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listExportBuckets` - `experimental `: Returns all Export Buckets associated with the specified Project. -* :ref:`atlas-api-cloudBackups-listReplicaSetBackups` - `experimental `: Returns all snapshots of one cluster from the specified project. -* :ref:`atlas-api-cloudBackups-listServerlessBackupRestoreJobs` - `experimental `: Returns all restore jobs for one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-listServerlessBackups` - `experimental `: Returns all snapshots of one serverless instance from the specified project. -* :ref:`atlas-api-cloudBackups-listShardedClusterBackups` - `experimental `: Returns all snapshots of one sharded cluster from the specified project. -* :ref:`atlas-api-cloudBackups-takeSnapshot` - `experimental `: Takes one on-demand snapshot for the specified cluster. -* :ref:`atlas-api-cloudBackups-updateBackupSchedule` - `experimental `: Updates the cloud backup schedule for one cluster within the specified project. -* :ref:`atlas-api-cloudBackups-updateDataProtectionSettings` - `experimental `: Updates the Backup Compliance Policy settings for the specified project. -* :ref:`atlas-api-cloudBackups-updateSnapshotRetention` - `experimental `: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-cloudBackups-cancelBackupRestoreJob` - `experimental `_: Cancels one cloud backup restore job of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-createBackupExportJob` - `experimental `_: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. +* :ref:`atlas-api-cloudBackups-createBackupRestoreJob` - `experimental `_: Restores one snapshot of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-createExportBucket` - `experimental `_: Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. +* :ref:`atlas-api-cloudBackups-createServerlessBackupRestoreJob` - `experimental `_: Restores one snapshot of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-deleteAllBackupSchedules` - `experimental `_: Removes all cloud backup schedules for the specified cluster. +* :ref:`atlas-api-cloudBackups-deleteExportBucket` - `experimental `_: Deletes an Export Bucket. +* :ref:`atlas-api-cloudBackups-deleteReplicaSetBackup` - `experimental `_: Removes the specified snapshot. +* :ref:`atlas-api-cloudBackups-deleteShardedClusterBackup` - `experimental `_: Removes one snapshot of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-disableDataProtectionSettings` - `experimental `_: Disables the Backup Compliance Policy settings with the specified project. +* :ref:`atlas-api-cloudBackups-getBackupExportJob` - `experimental `_: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. +* :ref:`atlas-api-cloudBackups-getBackupRestoreJob` - `experimental `_: Returns one cloud backup restore job for one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-getBackupSchedule` - `experimental `_: Returns the cloud backup schedule for the specified cluster within the specified project. +* :ref:`atlas-api-cloudBackups-getDataProtectionSettings` - `experimental `_: Returns the Backup Compliance Policy settings with the specified project. +* :ref:`atlas-api-cloudBackups-getExportBucket` - `experimental `_: Returns one Export Bucket associated with the specified Project. +* :ref:`atlas-api-cloudBackups-getReplicaSetBackup` - `experimental `_: Returns one snapshot from the specified cluster. +* :ref:`atlas-api-cloudBackups-getServerlessBackup` - `experimental `_: Returns one snapshot of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-getServerlessBackupRestoreJob` - `experimental `_: Returns one restore job for one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-getShardedClusterBackup` - `experimental `_: Returns one snapshot of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listBackupExportJobs` - `experimental `_: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. +* :ref:`atlas-api-cloudBackups-listBackupRestoreJobs` - `experimental `_: Returns all cloud backup restore jobs for one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listExportBuckets` - `experimental `_: Returns all Export Buckets associated with the specified Project. +* :ref:`atlas-api-cloudBackups-listReplicaSetBackups` - `experimental `_: Returns all snapshots of one cluster from the specified project. +* :ref:`atlas-api-cloudBackups-listServerlessBackupRestoreJobs` - `experimental `_: Returns all restore jobs for one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-listServerlessBackups` - `experimental `_: Returns all snapshots of one serverless instance from the specified project. +* :ref:`atlas-api-cloudBackups-listShardedClusterBackups` - `experimental `_: Returns all snapshots of one sharded cluster from the specified project. +* :ref:`atlas-api-cloudBackups-takeSnapshot` - `experimental `_: Takes one on-demand snapshot for the specified cluster. +* :ref:`atlas-api-cloudBackups-updateBackupSchedule` - `experimental `_: Updates the cloud backup schedule for one cluster within the specified project. +* :ref:`atlas-api-cloudBackups-updateDataProtectionSettings` - `experimental `_: Updates the Backup Compliance Policy settings for the specified project. +* :ref:`atlas-api-cloudBackups-updateSnapshotRetention` - `experimental `_: 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 1d4ad216bd..be57cf12dc 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 -`experimental `: Create one link-token that contains all the information required to complete the link. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'createLinkToken'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createLinkToken diff --git a/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-createPushMigration.txt index e88df0b1c2..9d63280f5d 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 -`experimental `: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. +`experimental `_: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. Please make sure to validate your migration before initiating it. You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource. NOTE: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster. This command is invoking the endpoint with OperationID: 'createPushMigration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createPushMigration diff --git a/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt b/docs/command/atlas-api-cloudMigrationService-cutoverMigration.txt index b4aa4940a6..f4d93bdf2f 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 -`experimental `: Cut over the migrated cluster to MongoDB Atlas. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'cutoverMigration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/cutoverMigration diff --git a/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt b/docs/command/atlas-api-cloudMigrationService-deleteLinkToken.txt index 62393b5951..25674502f2 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 -`experimental `: Remove one organization link and its associated public API key. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'deleteLinkToken'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/deleteLinkToken diff --git a/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt b/docs/command/atlas-api-cloudMigrationService-getPushMigration.txt index 9aedce4b5d..13630c055c 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 -`experimental `: Return details of one cluster migration job. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'getPushMigration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getPushMigration diff --git a/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt b/docs/command/atlas-api-cloudMigrationService-getValidationStatus.txt index 4feee7c730..454b64c32a 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 -`experimental `: Return the status of one migration validation job. +`experimental `_: Return the status of one migration validation job. Your API Key must have the Organization Owner role to successfully call this resource. This command is invoking the endpoint with OperationID: 'getValidationStatus'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getValidationStatus diff --git a/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt b/docs/command/atlas-api-cloudMigrationService-listSourceProjects.txt index 8b10b07fdb..60625fe049 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 -`experimental `: Return all projects that you can migrate to the specified organization. +`experimental `_: Return all projects that you can migrate to the specified organization. This command is invoking the endpoint with OperationID: 'listSourceProjects'. For more information about flags, format of --file and examples, see: 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 f721561a8c..80265a4c10 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 -`experimental `: Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'validateMigration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateMigration diff --git a/docs/command/atlas-api-cloudMigrationService.txt b/docs/command/atlas-api-cloudMigrationService.txt index 6635b46daf..e60e081579 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 -`experimental `: Manages the Cloud Migration Service. +`experimental `_: 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 +51,14 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudMigrationService-createLinkToken` - `experimental `: Create one link-token that contains all the information required to complete the link. -* :ref:`atlas-api-cloudMigrationService-createPushMigration` - `experimental `: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. -* :ref:`atlas-api-cloudMigrationService-cutoverMigration` - `experimental `: Cut over the migrated cluster to MongoDB Atlas. -* :ref:`atlas-api-cloudMigrationService-deleteLinkToken` - `experimental `: Remove one organization link and its associated public API key. -* :ref:`atlas-api-cloudMigrationService-getPushMigration` - `experimental `: Return details of one cluster migration job. -* :ref:`atlas-api-cloudMigrationService-getValidationStatus` - `experimental `: Return the status of one migration validation job. -* :ref:`atlas-api-cloudMigrationService-listSourceProjects` - `experimental `: Return all projects that you can migrate to the specified organization. -* :ref:`atlas-api-cloudMigrationService-validateMigration` - `experimental `: 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` - `experimental `_: Create one link-token that contains all the information required to complete the link. +* :ref:`atlas-api-cloudMigrationService-createPushMigration` - `experimental `_: Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas. +* :ref:`atlas-api-cloudMigrationService-cutoverMigration` - `experimental `_: Cut over the migrated cluster to MongoDB Atlas. +* :ref:`atlas-api-cloudMigrationService-deleteLinkToken` - `experimental `_: Remove one organization link and its associated public API key. +* :ref:`atlas-api-cloudMigrationService-getPushMigration` - `experimental `_: Return details of one cluster migration job. +* :ref:`atlas-api-cloudMigrationService-getValidationStatus` - `experimental `_: Return the status of one migration validation job. +* :ref:`atlas-api-cloudMigrationService-listSourceProjects` - `experimental `_: Return all projects that you can migrate to the specified organization. +* :ref:`atlas-api-cloudMigrationService-validateMigration` - `experimental `_: 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 1b3dfa8e42..d048be2b28 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 -`experimental `: Grants access to the specified project for the specified access role. +`experimental `_: Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. This is not required for GCP service account access. This command is invoking the endpoint with OperationID: 'authorizeCloudProviderAccessRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/authorizeCloudProviderAccessRole diff --git a/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt index d30efc264a..45589716f4 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 -`experimental `: Creates one access role for the specified cloud provider. +`experimental `_: Creates one access role for the specified cloud provider. Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createCloudProviderAccessRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/createCloudProviderAccessRole diff --git a/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole.txt index a68603779a..851cd99484 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 -`experimental `: Revokes access to the specified project for the specified access role. +`experimental `_: Revokes access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deauthorizeCloudProviderAccessRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/deauthorizeCloudProviderAccessRole diff --git a/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt b/docs/command/atlas-api-cloudProviderAccess-getCloudProviderAccessRole.txt index dae378ea37..b3b3d6e1aa 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 -`experimental `: Returns the access role with the specified id and with access to the specified project. +`experimental `_: Returns the access role with the specified id and with access to the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getCloudProviderAccessRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/getCloudProviderAccessRole diff --git a/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt b/docs/command/atlas-api-cloudProviderAccess-listCloudProviderAccessRoles.txt index 93691333a4..c4ba149930 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 -`experimental `: Returns all cloud provider access roles with access to the specified project. +`experimental `_: Returns all cloud provider access roles with access to the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'listCloudProviderAccessRoles'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/listCloudProviderAccessRoles diff --git a/docs/command/atlas-api-cloudProviderAccess.txt b/docs/command/atlas-api-cloudProviderAccess.txt index ba72068364..28eecda3ea 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 -`experimental `: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. +`experimental `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. Options ------- @@ -49,11 +49,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole` - `experimental `: Grants access to the specified project for the specified access role. -* :ref:`atlas-api-cloudProviderAccess-createCloudProviderAccessRole` - `experimental `: Creates one access role for the specified cloud provider. -* :ref:`atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole` - `experimental `: Revokes access to the specified project for the specified access role. -* :ref:`atlas-api-cloudProviderAccess-getCloudProviderAccessRole` - `experimental `: Returns the access role with the specified id and with access to the specified project. -* :ref:`atlas-api-cloudProviderAccess-listCloudProviderAccessRoles` - `experimental `: Returns all cloud provider access roles with access to the specified project. +* :ref:`atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole` - `experimental `_: Grants access to the specified project for the specified access role. +* :ref:`atlas-api-cloudProviderAccess-createCloudProviderAccessRole` - `experimental `_: Creates one access role for the specified cloud provider. +* :ref:`atlas-api-cloudProviderAccess-deauthorizeCloudProviderAccessRole` - `experimental `_: Revokes access to the specified project for the specified access role. +* :ref:`atlas-api-cloudProviderAccess-getCloudProviderAccessRole` - `experimental `_: Returns the access role with the specified id and with access to the specified project. +* :ref:`atlas-api-cloudProviderAccess-listCloudProviderAccessRoles` - `experimental `_: 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 70c6a07348..932ddb7cfd 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 -`experimental `: Ends a cluster outage simulation. +`experimental `_: Ends a cluster outage simulation. This command is invoking the endpoint with OperationID: 'endOutageSimulation'. For more information about flags, format of --file and examples, see: 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 85f448f600..39a15a2a67 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 -`experimental `: Returns one outage simulation for one cluster. +`experimental `_: Returns one outage simulation for one cluster. This command is invoking the endpoint with OperationID: 'getOutageSimulation'. For more information about flags, format of --file and examples, see: 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 fdadf2d307..e562b744b9 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 -`experimental `: Starts a cluster outage simulation. +`experimental `_: Starts a cluster outage simulation. This command is invoking the endpoint with OperationID: 'startOutageSimulation'. For more information about flags, format of --file and examples, see: 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 1d77b31b23..ba590e783f 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 -`experimental `: Returns, starts, or ends a cluster outage simulation. +`experimental `_: Returns, starts, or ends a cluster outage simulation. Options ------- @@ -49,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-clusterOutageSimulation-endOutageSimulation` - `experimental `: Ends a cluster outage simulation. -* :ref:`atlas-api-clusterOutageSimulation-getOutageSimulation` - `experimental `: Returns one outage simulation for one cluster. -* :ref:`atlas-api-clusterOutageSimulation-startOutageSimulation` - `experimental `: Starts a cluster outage simulation. +* :ref:`atlas-api-clusterOutageSimulation-endOutageSimulation` - `experimental `_: Ends a cluster outage simulation. +* :ref:`atlas-api-clusterOutageSimulation-getOutageSimulation` - `experimental `_: Returns one outage simulation for one cluster. +* :ref:`atlas-api-clusterOutageSimulation-startOutageSimulation` - `experimental `_: Starts a cluster outage simulation. .. toctree:: diff --git a/docs/command/atlas-api-clusters-createCluster.txt b/docs/command/atlas-api-clusters-createCluster.txt index 888262d2f3..d0631d650b 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 -`experimental `: Creates one cluster in the specified project. +`experimental `_: Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters. This command is invoking the endpoint with OperationID: 'createCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster diff --git a/docs/command/atlas-api-clusters-deleteCluster.txt b/docs/command/atlas-api-clusters-deleteCluster.txt index 9948a920f1..c47ad362e1 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 -`experimental `: Removes one cluster from the specified project. +`experimental `_: Removes one cluster from the specified project. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters. This command is invoking the endpoint with OperationID: 'deleteCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/deleteCluster diff --git a/docs/command/atlas-api-clusters-getCluster.txt b/docs/command/atlas-api-clusters-getCluster.txt index 456b87a373..f5fe9c9b03 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 -`experimental `: Returns the details for one cluster in the specified project. +`experimental `_: Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. This command is invoking the endpoint with OperationID: 'getCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster diff --git a/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-getClusterAdvancedConfiguration.txt index 61a5faa191..1e55974cdf 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 -`experimental `: Returns the advanced configuration details for one cluster in the specified project. +`experimental `_: 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 API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getClusterAdvancedConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterAdvancedConfiguration diff --git a/docs/command/atlas-api-clusters-getClusterStatus.txt b/docs/command/atlas-api-clusters-getClusterStatus.txt index aca0d52275..af8c14606e 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 -`experimental `: Returns the status of all changes that you made to the specified cluster in the specified project. +`experimental `_: Returns the status of all changes that you made to the specified cluster in the specified project. Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getClusterStatus'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterStatus diff --git a/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt b/docs/command/atlas-api-clusters-getSampleDatasetLoadStatus.txt index 879a7a9079..55308baf79 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 -`experimental `: Checks the progress of loading the sample dataset into one cluster. +`experimental `_: Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getSampleDatasetLoadStatus'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getSampleDatasetLoadStatus diff --git a/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt index a9f7f93250..84cf5390eb 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 -`experimental `: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. +`experimental `_: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. This command is invoking the endpoint with OperationID: 'grantMongoDbEmployeeAccess'. For more information about flags, format of --file and examples, see: 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 f62a2cc3c9..764da899cd 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 -`experimental `: Returns the list of regions available for the specified cloud provider at the specified tier. +`experimental `_: Returns the list of regions available for the specified cloud provider at the specified tier. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listCloudProviderRegions'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listCloudProviderRegions diff --git a/docs/command/atlas-api-clusters-listClusters.txt b/docs/command/atlas-api-clusters-listClusters.txt index 0d748141fe..f76c14642f 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 -`experimental `: Returns the details for all clusters in the specific project to which you have access. +`experimental `_: Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. This command is invoking the endpoint with OperationID: 'listClusters'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusters diff --git a/docs/command/atlas-api-clusters-listClustersForAllProjects.txt b/docs/command/atlas-api-clusters-listClustersForAllProjects.txt index b001a987c1..ad2b853688 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 -`experimental `: Returns the details for all clusters in all projects to which you have access. +`experimental `_: Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting API Key can have any cluster-level role. This command is invoking the endpoint with OperationID: 'listClustersForAllProjects'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClustersForAllProjects diff --git a/docs/command/atlas-api-clusters-loadSampleDataset.txt b/docs/command/atlas-api-clusters-loadSampleDataset.txt index 6055447871..8b00dac225 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 -`experimental `: Requests loading the MongoDB sample dataset into the specified cluster. +`experimental `_: Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'loadSampleDataset'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/loadSampleDataset diff --git a/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt index e2dfcaed3f..6022a29661 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 -`experimental `: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'pinFeatureCompatibilityVersion'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/pinFeatureCompatibilityVersion diff --git a/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt b/docs/command/atlas-api-clusters-revokeMongoDbEmployeeAccess.txt index e96db40b00..6a04592404 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 -`experimental `: Revokes a previously granted MongoDB employee cluster access. +`experimental `_: Revokes a previously granted MongoDB employee cluster access. This command is invoking the endpoint with OperationID: 'revokeMongoDbEmployeeAccess'. For more information about flags, format of --file and examples, see: 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 24b11e4ca3..80923134fe 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 -`experimental `: Starts a failover test for the specified cluster in the specified project. +`experimental `_: Starts a failover test for the specified cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting API Key must have the Project Cluster Manager role. This command is invoking the endpoint with OperationID: 'testFailover'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/testFailover diff --git a/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt b/docs/command/atlas-api-clusters-unpinFeatureCompatibilityVersion.txt index 71b51aba2e..e7676252a2 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 -`experimental `: Unpins the current fixed Feature Compatibility Version (FCV). +`experimental `_: Unpins the current fixed Feature Compatibility Version (FCV). This feature is not available for clusters on rapid release. This command is invoking the endpoint with OperationID: 'unpinFeatureCompatibilityVersion'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/unpinFeatureCompatibilityVersion diff --git a/docs/command/atlas-api-clusters-updateCluster.txt b/docs/command/atlas-api-clusters-updateCluster.txt index 334e2c0a43..7879b7397f 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 -`experimental `: Updates the details for one cluster in the specified project. +`experimental `_: Updates the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can update clusters with asymmetrically-sized shards. To update a cluster's termination protection, the requesting API Key must have the Project Owner role. For all other updates, the requesting API Key must have the Project Cluster Manager role. You can't modify a paused cluster (paused : true). You must call this endpoint to set paused : false. After this endpoint responds with paused : false, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters. This command is invoking the endpoint with OperationID: 'updateCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateCluster diff --git a/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt b/docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt index f774d9bbb3..cc96847b37 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 -`experimental `: Updates the advanced configuration details for one cluster in the specified project. +`experimental `_: Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting API Key must have the Project Cluster Manager role. This feature isn't available for M0 free clusters, M2 and M5 shared-tier clusters, flex clusters, or serverless clusters. This command is invoking the endpoint with OperationID: 'updateClusterAdvancedConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateClusterAdvancedConfiguration diff --git a/docs/command/atlas-api-clusters-upgradeSharedCluster.txt b/docs/command/atlas-api-clusters-upgradeSharedCluster.txt index 514feda8cc..b0ba88fe63 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 -`experimental `: Upgrades a shared-tier cluster to a dedicated cluster (M10+) in the specified project. +`experimental `_: Upgrades a shared-tier cluster to a dedicated cluster (M10+) in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. Each project supports up to 25 clusters. This command is invoking the endpoint with OperationID: 'upgradeSharedCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedCluster diff --git a/docs/command/atlas-api-clusters-upgradeSharedClusterToServerless.txt b/docs/command/atlas-api-clusters-upgradeSharedClusterToServerless.txt index 26dd295e63..cded906306 100644 --- a/docs/command/atlas-api-clusters-upgradeSharedClusterToServerless.txt +++ b/docs/command/atlas-api-clusters-upgradeSharedClusterToServerless.txt @@ -12,7 +12,7 @@ atlas api clusters upgradeSharedClusterToServerless :depth: 1 :class: singlecol -`experimental `: Upgrades a shared-tier cluster to a serverless instance in the specified project. +`experimental `_: Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. This command is invoking the endpoint with OperationID: 'upgradeSharedClusterToServerless'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedClusterToServerless diff --git a/docs/command/atlas-api-clusters.txt b/docs/command/atlas-api-clusters.txt index 4fcbbb0c4d..13da425b60 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 -`experimental `: Returns, adds, edits, and removes database deployments. +`experimental `_: Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID. @@ -51,25 +51,25 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-clusters-createCluster` - `experimental `: Creates one cluster in the specified project. -* :ref:`atlas-api-clusters-deleteCluster` - `experimental `: Removes one cluster from the specified project. -* :ref:`atlas-api-clusters-getCluster` - `experimental `: Returns the details for one cluster in the specified project. -* :ref:`atlas-api-clusters-getClusterAdvancedConfiguration` - `experimental `: Returns the advanced configuration details for one cluster in the specified project. -* :ref:`atlas-api-clusters-getClusterStatus` - `experimental `: Returns the status of all changes that you made to the specified cluster in the specified project. -* :ref:`atlas-api-clusters-getSampleDatasetLoadStatus` - `experimental `: Checks the progress of loading the sample dataset into one cluster. -* :ref:`atlas-api-clusters-grantMongoDbEmployeeAccess` - `experimental `: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. -* :ref:`atlas-api-clusters-listCloudProviderRegions` - `experimental `: Returns the list of regions available for the specified cloud provider at the specified tier. -* :ref:`atlas-api-clusters-listClusters` - `experimental `: Returns the details for all clusters in the specific project to which you have access. -* :ref:`atlas-api-clusters-listClustersForAllProjects` - `experimental `: Returns the details for all clusters in all projects to which you have access. -* :ref:`atlas-api-clusters-loadSampleDataset` - `experimental `: Requests loading the MongoDB sample dataset into the specified cluster. -* :ref:`atlas-api-clusters-pinFeatureCompatibilityVersion` - `experimental `: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. -* :ref:`atlas-api-clusters-revokeMongoDbEmployeeAccess` - `experimental `: Revokes a previously granted MongoDB employee cluster access. -* :ref:`atlas-api-clusters-testFailover` - `experimental `: Starts a failover test for the specified cluster in the specified project. -* :ref:`atlas-api-clusters-unpinFeatureCompatibilityVersion` - `experimental `: Unpins the current fixed Feature Compatibility Version (FCV). -* :ref:`atlas-api-clusters-updateCluster` - `experimental `: Updates the details for one cluster in the specified project. -* :ref:`atlas-api-clusters-updateClusterAdvancedConfiguration` - `experimental `: Updates the advanced configuration details for one cluster in the specified project. -* :ref:`atlas-api-clusters-upgradeSharedCluster` - `experimental `: Upgrades a shared-tier cluster to a dedicated cluster (M10+) in the specified project. -* :ref:`atlas-api-clusters-upgradeSharedClusterToServerless` - `experimental `: Upgrades a shared-tier cluster to a serverless instance in the specified project. +* :ref:`atlas-api-clusters-createCluster` - `experimental `_: Creates one cluster in the specified project. +* :ref:`atlas-api-clusters-deleteCluster` - `experimental `_: Removes one cluster from the specified project. +* :ref:`atlas-api-clusters-getCluster` - `experimental `_: Returns the details for one cluster in the specified project. +* :ref:`atlas-api-clusters-getClusterAdvancedConfiguration` - `experimental `_: Returns the advanced configuration details for one cluster in the specified project. +* :ref:`atlas-api-clusters-getClusterStatus` - `experimental `_: Returns the status of all changes that you made to the specified cluster in the specified project. +* :ref:`atlas-api-clusters-getSampleDatasetLoadStatus` - `experimental `_: Checks the progress of loading the sample dataset into one cluster. +* :ref:`atlas-api-clusters-grantMongoDbEmployeeAccess` - `experimental `_: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster. +* :ref:`atlas-api-clusters-listCloudProviderRegions` - `experimental `_: Returns the list of regions available for the specified cloud provider at the specified tier. +* :ref:`atlas-api-clusters-listClusters` - `experimental `_: Returns the details for all clusters in the specific project to which you have access. +* :ref:`atlas-api-clusters-listClustersForAllProjects` - `experimental `_: Returns the details for all clusters in all projects to which you have access. +* :ref:`atlas-api-clusters-loadSampleDataset` - `experimental `_: Requests loading the MongoDB sample dataset into the specified cluster. +* :ref:`atlas-api-clusters-pinFeatureCompatibilityVersion` - `experimental `_: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date. +* :ref:`atlas-api-clusters-revokeMongoDbEmployeeAccess` - `experimental `_: Revokes a previously granted MongoDB employee cluster access. +* :ref:`atlas-api-clusters-testFailover` - `experimental `_: Starts a failover test for the specified cluster in the specified project. +* :ref:`atlas-api-clusters-unpinFeatureCompatibilityVersion` - `experimental `_: Unpins the current fixed Feature Compatibility Version (FCV). +* :ref:`atlas-api-clusters-updateCluster` - `experimental `_: Updates the details for one cluster in the specified project. +* :ref:`atlas-api-clusters-updateClusterAdvancedConfiguration` - `experimental `_: Updates the advanced configuration details for one cluster in the specified project. +* :ref:`atlas-api-clusters-upgradeSharedCluster` - `experimental `_: Upgrades a shared-tier cluster to a dedicated cluster (M10+) in the specified project. +* :ref:`atlas-api-clusters-upgradeSharedClusterToServerless` - `experimental `_: Upgrades a shared-tier cluster to a serverless instance in the specified project. .. toctree:: diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements.txt index 38740913c1..7a493de619 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 -`experimental `: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. +`experimental `_: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. This command is invoking the endpoint with OperationID: 'getCollStatsLatencyNamespaceClusterMeasurements'. For more information about flags, format of --file and examples, see: 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 2772fb3ff9..09729b9d5a 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 -`experimental `: Get a list of the Coll Stats Latency process-level measurements for the given namespace +`experimental `_: Get a list of the Coll Stats Latency process-level measurements for the given namespace This command is invoking the endpoint with OperationID: 'getCollStatsLatencyNamespaceHostMeasurements'. diff --git a/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics.txt index 9912d0dc66..9f8f33559f 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 -`experimental `: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. +`experimental `_: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. This command is invoking the endpoint with OperationID: 'getCollStatsLatencyNamespaceMetrics'. For more information about flags, format of --file and examples, see: 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 520707b447..4700c58f3e 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 -`experimental `: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. +`experimental `_: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. This command is invoking the endpoint with OperationID: 'getCollStatsLatencyNamespacesForCluster'. For more information about flags, format of --file and examples, see: 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 5f6ed2b7ca..84da9adb26 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 -`experimental `: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. +`experimental `_: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. This command is invoking the endpoint with OperationID: 'getCollStatsLatencyNamespacesForHost'. For more information about flags, format of --file and examples, see: 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 b88f1edba4..18db190a2f 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 -`experimental `: Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. +`experimental `_: 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 invoking the endpoint with OperationID: 'getPinnedNamespaces'. For more information about flags, format of --file and examples, see: 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 a8f6e066c1..2325940852 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 -`experimental `: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster +`experimental `_: 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 invoking the endpoint with OperationID: 'pinNamespacesPatch'. diff --git a/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt b/docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt index 8b4f99cac6..e4cb5846a9 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 -`experimental `: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'pinNamespacesPut'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPut diff --git a/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt b/docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt index 2884333a9b..0fe24b74a4 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 -`experimental `: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster +`experimental `_: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster This command is invoking the endpoint with OperationID: 'unpinNamespaces'. diff --git a/docs/command/atlas-api-collectionLevelMetrics.txt b/docs/command/atlas-api-collectionLevelMetrics.txt index f95ae2d728..f3b48f55b4 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 -`experimental `: Returns, adds, and edits pinned namespaces for the specified cluster or process. +`experimental `_: Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level latency metric data. @@ -51,19 +51,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements` - `experimental `: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements` - `experimental `: Get a list of the Coll Stats Latency process-level measurements for the given namespace +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceClusterMeasurements` - `experimental `_: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. +* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceHostMeasurements` - `experimental `_: Get a list of the Coll Stats Latency process-level measurements for the given namespace This command is invoking the endpoint with OperationID: 'getCollStatsLatencyNamespaceHostMeasurements'. -* :ref:`atlas-api-collectionLevelMetrics-getCollStatsLatencyNamespaceMetrics` - `experimental `: 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` - `experimental `: 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` - `experimental `: 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` - `experimental `: 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` - `experimental `: 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-getCollStatsLatencyNamespaceMetrics` - `experimental `_: 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` - `experimental `_: 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` - `experimental `_: 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` - `experimental `_: 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` - `experimental `_: 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 invoking the endpoint with OperationID: 'pinNamespacesPatch'. -* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPut` - `experimental `: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. -* :ref:`atlas-api-collectionLevelMetrics-unpinNamespaces` - `experimental `: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster +* :ref:`atlas-api-collectionLevelMetrics-pinNamespacesPut` - `experimental `_: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. +* :ref:`atlas-api-collectionLevelMetrics-unpinNamespaces` - `experimental `_: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster This command is invoking the endpoint with OperationID: 'unpinNamespaces'. diff --git a/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt index a5da502463..f63b710576 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 -`experimental `: Creates one custom role in the specified project. +`experimental `_: Creates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createCustomDatabaseRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/createCustomDatabaseRole diff --git a/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-deleteCustomDatabaseRole.txt index 869b4e8b68..967db6cab4 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 -`experimental `: Removes one custom role from the specified project. +`experimental `_: Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting API Key must have the Project Atlas Admin role. This command is invoking the endpoint with OperationID: 'deleteCustomDatabaseRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/deleteCustomDatabaseRole diff --git a/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-getCustomDatabaseRole.txt index 8bb4b807ba..9ef891cf16 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 -`experimental `: Returns one custom role for the specified project. +`experimental `_: Returns one custom role for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getCustomDatabaseRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/getCustomDatabaseRole diff --git a/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles-listCustomDatabaseRoles.txt index 188bdfcd06..b7ec2e969c 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 -`experimental `: Returns all custom roles for the specified project. +`experimental `_: Returns all custom roles for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listCustomDatabaseRoles'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/listCustomDatabaseRoles diff --git a/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt b/docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt index 3da7a3cee7..b9f2f74341 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 -`experimental `: Updates one custom role in the specified project. +`experimental `_: Updates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateCustomDatabaseRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/updateCustomDatabaseRole diff --git a/docs/command/atlas-api-customDatabaseRoles.txt b/docs/command/atlas-api-customDatabaseRoles.txt index 1ca325b225..90b0445fe2 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 -`experimental `: Returns, adds, edits, and removes custom database user privilege roles. +`experimental `_: 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 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-customDatabaseRoles-createCustomDatabaseRole` - `experimental `: Creates one custom role in the specified project. -* :ref:`atlas-api-customDatabaseRoles-deleteCustomDatabaseRole` - `experimental `: Removes one custom role from the specified project. -* :ref:`atlas-api-customDatabaseRoles-getCustomDatabaseRole` - `experimental `: Returns one custom role for the specified project. -* :ref:`atlas-api-customDatabaseRoles-listCustomDatabaseRoles` - `experimental `: Returns all custom roles for the specified project. -* :ref:`atlas-api-customDatabaseRoles-updateCustomDatabaseRole` - `experimental `: Updates one custom role in the specified project. +* :ref:`atlas-api-customDatabaseRoles-createCustomDatabaseRole` - `experimental `_: Creates one custom role in the specified project. +* :ref:`atlas-api-customDatabaseRoles-deleteCustomDatabaseRole` - `experimental `_: Removes one custom role from the specified project. +* :ref:`atlas-api-customDatabaseRoles-getCustomDatabaseRole` - `experimental `_: Returns one custom role for the specified project. +* :ref:`atlas-api-customDatabaseRoles-listCustomDatabaseRoles` - `experimental `_: Returns all custom roles for the specified project. +* :ref:`atlas-api-customDatabaseRoles-updateCustomDatabaseRole` - `experimental `_: 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 0ee28570d8..155d355932 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 -`experimental `: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. +`experimental `_: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. us-east-1 is com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4. us-west-1 is com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb. eu-west-1 is com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e. eu-west-2 is com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9. eu-central-1 is com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d. sa-east-1 is com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044. ap-southeast-2 is com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e. ap-south-1 is com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'createDataFederationPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createDataFederationPrivateEndpoint diff --git a/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-createFederatedDatabase.txt index 2cc2592af5..ab5240bc57 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 -`experimental `: Creates one federated database instance in the specified project. +`experimental `_: Creates one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'createFederatedDatabase'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createFederatedDatabase diff --git a/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt b/docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt index e887852650..229dec80d2 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 -`experimental `: Creates or updates one query limit for one federated database instance. +`experimental `_: Creates or updates one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createOneDataFederationQueryLimit'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createOneDataFederationQueryLimit diff --git a/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-deleteDataFederationPrivateEndpoint.txt index 001ca43445..309bb9b386 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 -`experimental `: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. +`experimental `_: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteDataFederationPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteDataFederationPrivateEndpoint diff --git a/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-deleteFederatedDatabase.txt index dcc6b839f1..9d9997e469 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 -`experimental `: Removes one federated database instance from the specified project. +`experimental `_: Removes one federated database instance from the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'deleteFederatedDatabase'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteFederatedDatabase diff --git a/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt b/docs/command/atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit.txt index 24bc852d44..53695afb13 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 -`experimental `: Deletes one query limit for one federated database instance. +`experimental `_: Deletes one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteOneDataFederationInstanceQueryLimit'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteOneDataFederationInstanceQueryLimit diff --git a/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt b/docs/command/atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs.txt index 7c50c2bc1b..fb602ceba7 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 -`experimental `: Downloads the query logs for the specified federated database instance. +`experimental `_: Downloads the query logs for the specified federated database instance. To use this resource, the requesting API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". This command is invoking the endpoint with OperationID: 'downloadFederatedDatabaseQueryLogs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadFederatedDatabaseQueryLogs diff --git a/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt b/docs/command/atlas-api-dataFederation-getDataFederationPrivateEndpoint.txt index cd3738c84e..c4aba1801c 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 -`experimental `: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. +`experimental `_: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'getDataFederationPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getDataFederationPrivateEndpoint diff --git a/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-getFederatedDatabase.txt index 6678d44c35..fe68b7de6f 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 -`experimental `: Returns the details of one federated database instance within the specified project. +`experimental `_: Returns the details of one federated database instance within the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'getFederatedDatabase'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getFederatedDatabase diff --git a/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt b/docs/command/atlas-api-dataFederation-listDataFederationPrivateEndpoints.txt index 7bcc4759bc..2b0fbf1bf9 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 -`experimental `: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. +`experimental `_: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'listDataFederationPrivateEndpoints'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listDataFederationPrivateEndpoints diff --git a/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt b/docs/command/atlas-api-dataFederation-listFederatedDatabases.txt index 62ab6c81b5..370e9fbb68 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 -`experimental `: Returns the details of all federated database instances in the specified project. +`experimental `_: Returns the details of all federated database instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only or higher role. This command is invoking the endpoint with OperationID: 'listFederatedDatabases'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listFederatedDatabases diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimit.txt index 057250a8e9..2141a7b391 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 -`experimental `: Returns the details of one query limit for the specified federated database instance in the specified project. +`experimental `_: Returns the details of one query limit for the specified federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'returnFederatedDatabaseQueryLimit'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimit diff --git a/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt b/docs/command/atlas-api-dataFederation-returnFederatedDatabaseQueryLimits.txt index 650937d361..e2158b490a 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 -`experimental `: Returns query limits for a federated databases instance in the specified project. +`experimental `_: Returns query limits for a federated databases instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'returnFederatedDatabaseQueryLimits'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimits diff --git a/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt b/docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt index 184a24eb70..0abbf01d59 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 -`experimental `: Updates the details of one federated database instance in the specified project. +`experimental `_: Updates the details of one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or higher role. This command is invoking the endpoint with OperationID: 'updateFederatedDatabase'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/updateFederatedDatabase diff --git a/docs/command/atlas-api-dataFederation.txt b/docs/command/atlas-api-dataFederation.txt index 295f35aa07..20aafdeef2 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 -`experimental `: Returns, adds, edits, and removes Federated Database Instances. +`experimental `_: 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 +51,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-dataFederation-createDataFederationPrivateEndpoint` - `experimental `: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. -* :ref:`atlas-api-dataFederation-createFederatedDatabase` - `experimental `: Creates one federated database instance in the specified project. -* :ref:`atlas-api-dataFederation-createOneDataFederationQueryLimit` - `experimental `: Creates or updates one query limit for one federated database instance. -* :ref:`atlas-api-dataFederation-deleteDataFederationPrivateEndpoint` - `experimental `: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-deleteFederatedDatabase` - `experimental `: Removes one federated database instance from the specified project. -* :ref:`atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit` - `experimental `: Deletes one query limit for one federated database instance. -* :ref:`atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs` - `experimental `: Downloads the query logs for the specified federated database instance. -* :ref:`atlas-api-dataFederation-getDataFederationPrivateEndpoint` - `experimental `: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-getFederatedDatabase` - `experimental `: Returns the details of one federated database instance within the specified project. -* :ref:`atlas-api-dataFederation-listDataFederationPrivateEndpoints` - `experimental `: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. -* :ref:`atlas-api-dataFederation-listFederatedDatabases` - `experimental `: Returns the details of all federated database instances in the specified project. -* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimit` - `experimental `: Returns the details of one query limit for the specified federated database instance in the specified project. -* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimits` - `experimental `: Returns query limits for a federated databases instance in the specified project. -* :ref:`atlas-api-dataFederation-updateFederatedDatabase` - `experimental `: Updates the details of one federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-createDataFederationPrivateEndpoint` - `experimental `_: Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. +* :ref:`atlas-api-dataFederation-createFederatedDatabase` - `experimental `_: Creates one federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-createOneDataFederationQueryLimit` - `experimental `_: Creates or updates one query limit for one federated database instance. +* :ref:`atlas-api-dataFederation-deleteDataFederationPrivateEndpoint` - `experimental `_: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-deleteFederatedDatabase` - `experimental `_: Removes one federated database instance from the specified project. +* :ref:`atlas-api-dataFederation-deleteOneDataFederationInstanceQueryLimit` - `experimental `_: Deletes one query limit for one federated database instance. +* :ref:`atlas-api-dataFederation-downloadFederatedDatabaseQueryLogs` - `experimental `_: Downloads the query logs for the specified federated database instance. +* :ref:`atlas-api-dataFederation-getDataFederationPrivateEndpoint` - `experimental `_: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-getFederatedDatabase` - `experimental `_: Returns the details of one federated database instance within the specified project. +* :ref:`atlas-api-dataFederation-listDataFederationPrivateEndpoints` - `experimental `_: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. +* :ref:`atlas-api-dataFederation-listFederatedDatabases` - `experimental `_: Returns the details of all federated database instances in the specified project. +* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimit` - `experimental `_: Returns the details of one query limit for the specified federated database instance in the specified project. +* :ref:`atlas-api-dataFederation-returnFederatedDatabaseQueryLimits` - `experimental `_: Returns query limits for a federated databases instance in the specified project. +* :ref:`atlas-api-dataFederation-updateFederatedDatabase` - `experimental `_: 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 fa849ff9a6..02e6e170b5 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 -`experimental `: Creates one Data Lake Pipeline. +`experimental `_: Creates one Data Lake Pipeline. This command is invoking the endpoint with OperationID: 'createPipeline'. For more information about flags, format of --file and examples, see: 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 dad8070c22..b81c7d519b 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 -`experimental `: Removes one Data Lake Pipeline. +`experimental `_: Removes one Data Lake Pipeline. This command is invoking the endpoint with OperationID: 'deletePipeline'. For more information about flags, format of --file and examples, see: 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 6db087ec4d..27196bdb34 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 -`experimental `: Deletes dataset that Atlas generated during the specified pipeline run. +`experimental `_: Deletes dataset that Atlas generated during the specified pipeline run. This command is invoking the endpoint with OperationID: 'deletePipelineRunDataset'. For more information about flags, format of --file and examples, see: 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 86582dbfa8..ed11e3e42a 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 -`experimental `: Returns the details of one Data Lake Pipeline within the specified project. +`experimental `_: Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPipeline'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipeline diff --git a/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt b/docs/command/atlas-api-dataLakePipelines-getPipelineRun.txt index d191bd35ee..085129a98a 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 -`experimental `: Returns the details of one Data Lake Pipeline run within the specified project. +`experimental `_: Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPipelineRun'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipelineRun diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineRuns.txt index 1612242554..46d62998ea 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 -`experimental `: Returns a list of past Data Lake Pipeline runs. +`experimental `_: Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPipelineRuns'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineRuns diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineSchedules.txt index 01daccbb48..65eedca132 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 -`experimental `: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. +`experimental `_: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPipelineSchedules'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSchedules diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt b/docs/command/atlas-api-dataLakePipelines-listPipelineSnapshots.txt index cfd22ea365..01a76702e5 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 -`experimental `: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. +`experimental `_: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPipelineSnapshots'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSnapshots diff --git a/docs/command/atlas-api-dataLakePipelines-listPipelines.txt b/docs/command/atlas-api-dataLakePipelines-listPipelines.txt index eecfff6ff4..97e14ce13e 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 -`experimental `: Returns a list of Data Lake Pipelines. +`experimental `_: Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPipelines'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelines diff --git a/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt b/docs/command/atlas-api-dataLakePipelines-pausePipeline.txt index e96c5bef26..b4a5a6bfd6 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 -`experimental `: Pauses ingestion for a Data Lake Pipeline within the specified project. +`experimental `_: Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'pausePipeline'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/pausePipeline diff --git a/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt b/docs/command/atlas-api-dataLakePipelines-resumePipeline.txt index f6583d00e6..5aa52cc9b7 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 -`experimental `: Resumes ingestion for a Data Lake Pipeline within the specified project. +`experimental `_: Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'resumePipeline'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/resumePipeline diff --git a/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt b/docs/command/atlas-api-dataLakePipelines-triggerSnapshotIngestion.txt index f848559bec..e4bf2888e1 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 -`experimental `: Triggers a Data Lake Pipeline ingestion of a specified snapshot. +`experimental `_: Triggers a Data Lake Pipeline ingestion of a specified snapshot. This command is invoking the endpoint with OperationID: 'triggerSnapshotIngestion'. For more information about flags, format of --file and examples, see: 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 156f88bb22..d0a1386aa0 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 -`experimental `: Updates one Data Lake Pipeline. +`experimental `_: Updates one Data Lake Pipeline. This command is invoking the endpoint with OperationID: 'updatePipeline'. For more information about flags, format of --file and examples, see: 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 1adf38d09d..a9a4ceae89 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 -`experimental `: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. +`experimental `_: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. Options ------- @@ -49,19 +49,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-dataLakePipelines-createPipeline` - `experimental `: Creates one Data Lake Pipeline. -* :ref:`atlas-api-dataLakePipelines-deletePipeline` - `experimental `: Removes one Data Lake Pipeline. -* :ref:`atlas-api-dataLakePipelines-deletePipelineRunDataset` - `experimental `: Deletes dataset that Atlas generated during the specified pipeline run. -* :ref:`atlas-api-dataLakePipelines-getPipeline` - `experimental `: Returns the details of one Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-getPipelineRun` - `experimental `: Returns the details of one Data Lake Pipeline run within the specified project. -* :ref:`atlas-api-dataLakePipelines-listPipelineRuns` - `experimental `: Returns a list of past Data Lake Pipeline runs. -* :ref:`atlas-api-dataLakePipelines-listPipelineSchedules` - `experimental `: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. -* :ref:`atlas-api-dataLakePipelines-listPipelineSnapshots` - `experimental `: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. -* :ref:`atlas-api-dataLakePipelines-listPipelines` - `experimental `: Returns a list of Data Lake Pipelines. -* :ref:`atlas-api-dataLakePipelines-pausePipeline` - `experimental `: Pauses ingestion for a Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-resumePipeline` - `experimental `: Resumes ingestion for a Data Lake Pipeline within the specified project. -* :ref:`atlas-api-dataLakePipelines-triggerSnapshotIngestion` - `experimental `: Triggers a Data Lake Pipeline ingestion of a specified snapshot. -* :ref:`atlas-api-dataLakePipelines-updatePipeline` - `experimental `: Updates one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-createPipeline` - `experimental `_: Creates one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-deletePipeline` - `experimental `_: Removes one Data Lake Pipeline. +* :ref:`atlas-api-dataLakePipelines-deletePipelineRunDataset` - `experimental `_: Deletes dataset that Atlas generated during the specified pipeline run. +* :ref:`atlas-api-dataLakePipelines-getPipeline` - `experimental `_: Returns the details of one Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-getPipelineRun` - `experimental `_: Returns the details of one Data Lake Pipeline run within the specified project. +* :ref:`atlas-api-dataLakePipelines-listPipelineRuns` - `experimental `_: Returns a list of past Data Lake Pipeline runs. +* :ref:`atlas-api-dataLakePipelines-listPipelineSchedules` - `experimental `_: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. +* :ref:`atlas-api-dataLakePipelines-listPipelineSnapshots` - `experimental `_: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. +* :ref:`atlas-api-dataLakePipelines-listPipelines` - `experimental `_: Returns a list of Data Lake Pipelines. +* :ref:`atlas-api-dataLakePipelines-pausePipeline` - `experimental `_: Pauses ingestion for a Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-resumePipeline` - `experimental `_: Resumes ingestion for a Data Lake Pipeline within the specified project. +* :ref:`atlas-api-dataLakePipelines-triggerSnapshotIngestion` - `experimental `_: Triggers a Data Lake Pipeline ingestion of a specified snapshot. +* :ref:`atlas-api-dataLakePipelines-updatePipeline` - `experimental `_: 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 f019e60e67..e1dfcebaf6 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 -`experimental `: Creates one database user in the specified project. +`experimental `_: 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 API Key must have the Project Owner or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'createDatabaseUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/createDatabaseUser diff --git a/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-deleteDatabaseUser.txt index c37ee36ad3..db6310b1ea 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 -`experimental `: Removes one database user from the specified project. +`experimental `_: Removes one database user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteDatabaseUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/deleteDatabaseUser diff --git a/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-getDatabaseUser.txt index 0148a7ae62..3d10134cf1 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 -`experimental `: Returns one database user that belong to the specified project. +`experimental `_: Returns one database user that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getDatabaseUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/getDatabaseUser diff --git a/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt b/docs/command/atlas-api-databaseUsers-listDatabaseUsers.txt index 07455fee7c..937e9849dc 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 -`experimental `: Returns all database users that belong to the specified project. +`experimental `_: Returns all database users that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listDatabaseUsers'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/listDatabaseUsers diff --git a/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-updateDatabaseUser.txt index 7558d02270..23061b703a 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 -`experimental `: Updates one database user that belongs to the specified project. +`experimental `_: Updates one database user that belongs to the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. This command is invoking the endpoint with OperationID: 'updateDatabaseUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/updateDatabaseUser diff --git a/docs/command/atlas-api-databaseUsers.txt b/docs/command/atlas-api-databaseUsers.txt index 4a05b9cd52..d9cb041a85 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 -`experimental `: Returns, adds, edits, and removes database users. +`experimental `_: Returns, adds, edits, and removes database users. Options ------- @@ -49,11 +49,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-databaseUsers-createDatabaseUser` - `experimental `: Creates one database user in the specified project. -* :ref:`atlas-api-databaseUsers-deleteDatabaseUser` - `experimental `: Removes one database user from the specified project. -* :ref:`atlas-api-databaseUsers-getDatabaseUser` - `experimental `: Returns one database user that belong to the specified project. -* :ref:`atlas-api-databaseUsers-listDatabaseUsers` - `experimental `: Returns all database users that belong to the specified project. -* :ref:`atlas-api-databaseUsers-updateDatabaseUser` - `experimental `: Updates one database user that belongs to the specified project. +* :ref:`atlas-api-databaseUsers-createDatabaseUser` - `experimental `_: Creates one database user in the specified project. +* :ref:`atlas-api-databaseUsers-deleteDatabaseUser` - `experimental `_: Removes one database user from the specified project. +* :ref:`atlas-api-databaseUsers-getDatabaseUser` - `experimental `_: Returns one database user that belong to the specified project. +* :ref:`atlas-api-databaseUsers-listDatabaseUsers` - `experimental `_: Returns all database users that belong to the specified project. +* :ref:`atlas-api-databaseUsers-updateDatabaseUser` - `experimental `_: 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 aa4890439b..53632520e4 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 -`experimental `: Creates a private endpoint in the specified region for encryption at rest using customer key management. +`experimental `_: Creates a private endpoint in the specified region for encryption at rest using customer key management. This command is invoking the endpoint with OperationID: 'createEncryptionAtRestPrivateEndpoint'. For more information about flags, format of --file and examples, see: 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 e7bac1cb09..501671ea8f 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 -`experimental `: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. +`experimental `_: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Owner role. LIMITED TO M10 OR GREATER: MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater. This command is invoking the endpoint with OperationID: 'getEncryptionAtRest'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRest diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint.txt index 7600eadc6e..aab43005d7 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 -`experimental `: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +`experimental `_: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. This command is invoking the endpoint with OperationID: 'getEncryptionAtRestPrivateEndpoint'. For more information about flags, format of --file and examples, see: 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 4ce99ce2b2..0dcc7db486 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 -`experimental `: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. +`experimental `_: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. This command is invoking the endpoint with OperationID: 'getEncryptionAtRestPrivateEndpointsForCloudProvider'. For more information about flags, format of --file and examples, see: 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 f06e5580e1..a226929b4f 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 -`experimental `: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +`experimental `_: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. This command is invoking the endpoint with OperationID: 'requestEncryptionAtRestPrivateEndpointDeletion'. For more information about flags, format of --file and examples, see: 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 1438c67e43..55b01b0e30 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 -`experimental `: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. +`experimental `_: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Owner role. This feature isn't available for M0 free clusters, M2, M5, or serverless clusters. After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management. This command is invoking the endpoint with OperationID: 'updateEncryptionAtRest'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/updateEncryptionAtRest diff --git a/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt b/docs/command/atlas-api-encryptionAtRestUsingCustomerKeyManagement.txt index e3cc919a44..4a2b7c4279 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 -`experimental `: Returns and edits the Encryption at Rest using Customer Key Management configuration. +`experimental `_: 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 +51,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint` - `experimental `: Creates a private endpoint in the specified region for encryption at rest using customer key management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest` - `experimental `: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint` - `experimental `: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider` - `experimental `: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion` - `experimental `: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest` - `experimental `: Updates the configuration for encryption at rest using the keys you manage through your cloud provider. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-createEncryptionAtRestPrivateEndpoint` - `experimental `_: Creates a private endpoint in the specified region for encryption at rest using customer key management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRest` - `experimental `_: Returns the configuration for encryption at rest using the keys you manage through your cloud provider. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpoint` - `experimental `_: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-getEncryptionAtRestPrivateEndpointsForCloudProvider` - `experimental `_: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-requestEncryptionAtRestPrivateEndpointDeletion` - `experimental `_: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement-updateEncryptionAtRest` - `experimental `_: 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 babf404422..6c0814d8ec 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 -`experimental `: Returns one event for the specified organization. +`experimental `_: Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'getOrganizationEvent'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getOrganizationEvent diff --git a/docs/command/atlas-api-events-getProjectEvent.txt b/docs/command/atlas-api-events-getProjectEvent.txt index 915a0ebf76..86441b400e 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 -`experimental `: Returns one event for the specified project. +`experimental `_: Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'getProjectEvent'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getProjectEvent diff --git a/docs/command/atlas-api-events-listEventTypes.txt b/docs/command/atlas-api-events-listEventTypes.txt index b03b37058f..b57697f391 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 -`experimental `: Returns a list of all event types, along with a description and additional metadata about each event. +`experimental `_: Returns a list of all event types, along with a description and additional metadata about each event. This command is invoking the endpoint with OperationID: 'listEventTypes'. For more information about flags, format of --file and examples, see: 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 2da79903fd..e70e369d0f 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 -`experimental `: Returns all events for the specified organization. +`experimental `_: Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listOrganizationEvents'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrganizationEvents diff --git a/docs/command/atlas-api-events-listProjectEvents.txt b/docs/command/atlas-api-events-listProjectEvents.txt index 161f73ff00..6da030743b 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 -`experimental `: Returns all events for the specified project. +`experimental `_: Returns all events for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listProjectEvents'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listProjectEvents diff --git a/docs/command/atlas-api-events.txt b/docs/command/atlas-api-events.txt index a9c4c26a0f..a8ea0983f5 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 -`experimental `: Returns events. +`experimental `_: Returns events. This collection remains under revision and may change. @@ -51,11 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-events-getOrganizationEvent` - `experimental `: Returns one event for the specified organization. -* :ref:`atlas-api-events-getProjectEvent` - `experimental `: Returns one event for the specified project. -* :ref:`atlas-api-events-listEventTypes` - `experimental `: Returns a list of all event types, along with a description and additional metadata about each event. -* :ref:`atlas-api-events-listOrganizationEvents` - `experimental `: Returns all events for the specified organization. -* :ref:`atlas-api-events-listProjectEvents` - `experimental `: Returns all events for the specified project. +* :ref:`atlas-api-events-getOrganizationEvent` - `experimental `_: Returns one event for the specified organization. +* :ref:`atlas-api-events-getProjectEvent` - `experimental `_: Returns one event for the specified project. +* :ref:`atlas-api-events-listEventTypes` - `experimental `_: Returns a list of all event types, along with a description and additional metadata about each event. +* :ref:`atlas-api-events-listOrganizationEvents` - `experimental `_: Returns all events for the specified organization. +* :ref:`atlas-api-events-listProjectEvents` - `experimental `_: 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 15e3cad92c..a13cf443f7 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 -`experimental `: Creates one identity provider within the specified federation. +`experimental `_: Creates one identity provider within the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. Note: This resource only supports the creation of OIDC identity providers. This command is invoking the endpoint with OperationID: 'createIdentityProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createIdentityProvider diff --git a/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-createRoleMapping.txt index 33a0e0d72e..b268616069 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 -`experimental `: Adds one role mapping to the specified organization in the specified federation. +`experimental `_: Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'createRoleMapping'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createRoleMapping diff --git a/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt b/docs/command/atlas-api-federatedAuthentication-deleteFederationApp.txt index e21241b0c2..a40bd261b5 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 -`experimental `: Deletes the federation settings instance and all associated data, including identity providers and domains. +`experimental `_: Deletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting API Key must have the Organization Owner role in the last remaining connected organization. Note: requests to this resource will fail if there is more than one connected organization in the federation. This command is invoking the endpoint with OperationID: 'deleteFederationApp'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationApp diff --git a/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-deleteIdentityProvider.txt index 4a33b98428..25356dc9bd 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 -`experimental `: Deletes one identity provider in the specified federation. +`experimental `_: Deletes one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. Note: Requests to this resource will fail if the identity provider has any connected organizations. Before deleting an identity provider, disconnect all organizations and confirm that no organization in your account uses this identity provider. To learn more, see Manage Organization Mapping for Federated Authentication. This command is invoking the endpoint with OperationID: 'deleteIdentityProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteIdentityProvider diff --git a/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-deleteRoleMapping.txt index c36a612ecb..a0425fcd8b 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 -`experimental `: Removes one role mapping in the specified organization from the specified federation. +`experimental `_: Removes one role mapping in the specified organization from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'deleteRoleMapping'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteRoleMapping diff --git a/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-getConnectedOrgConfig.txt index e54b388d58..4e75447186 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 -`experimental `: Returns the specified connected org config from the specified federation. +`experimental `_: Returns the specified connected org config from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. This command is invoking the endpoint with OperationID: 'getConnectedOrgConfig'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getConnectedOrgConfig diff --git a/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt b/docs/command/atlas-api-federatedAuthentication-getFederationSettings.txt index dbbbcd3e14..3163c689a2 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 -`experimental `: Returns information about the federation settings for the specified organization. +`experimental `_: Returns information about the federation settings for the specified organization. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. This command is invoking the endpoint with OperationID: 'getFederationSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettings diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProvider.txt index 715cba2e3d..09536a4820 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 -`experimental `: Returns one identity provider in the specified federation by the identity provider's id. +`experimental `_: Returns one identity provider in the specified federation by the identity provider's id. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. This command is invoking the endpoint with OperationID: 'getIdentityProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProvider diff --git a/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt b/docs/command/atlas-api-federatedAuthentication-getIdentityProviderMetadata.txt index 4089e7406e..3c56fe43ae 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 -`experimental `: Returns the metadata of one identity provider in the specified federation. +`experimental `_: Returns the metadata of one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. This command is invoking the endpoint with OperationID: 'getIdentityProviderMetadata'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProviderMetadata diff --git a/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-getRoleMapping.txt index 3063a94533..d36160fd51 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 -`experimental `: Returns one role mapping from the specified organization in the specified federation. +`experimental `_: Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'getRoleMapping'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getRoleMapping diff --git a/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt b/docs/command/atlas-api-federatedAuthentication-listConnectedOrgConfigs.txt index b1cab70ecd..2084ff3cf2 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 -`experimental `: Returns all connected org configs in the specified federation. +`experimental `_: Returns all connected org configs in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected orgs. This command is invoking the endpoint with OperationID: 'listConnectedOrgConfigs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listConnectedOrgConfigs diff --git a/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt b/docs/command/atlas-api-federatedAuthentication-listIdentityProviders.txt index 96da9998fe..b612ba3f61 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 -`experimental `: Returns all identity providers with the provided protocol and type in the specified federation. +`experimental `_: Returns all identity providers with the provided protocol and type in the specified federation. If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. This command is invoking the endpoint with OperationID: 'listIdentityProviders'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listIdentityProviders diff --git a/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt b/docs/command/atlas-api-federatedAuthentication-listRoleMappings.txt index 5e9fe14f53..0051c0a89e 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 -`experimental `: Returns all role mappings from the specified organization in the specified federation. +`experimental `_: Returns all role mappings from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'listRoleMappings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listRoleMappings diff --git a/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-removeConnectedOrgConfig.txt index 2fab92adcd..c2f6f98c4a 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 -`experimental `: Removes one connected organization configuration from the specified federation. +`experimental `_: Removes one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation. This command is invoking the endpoint with OperationID: 'removeConnectedOrgConfig'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/removeConnectedOrgConfig diff --git a/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider.txt index a03ea71062..ac97965a84 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 -`experimental `: Revokes the JWKS tokens from the requested OIDC identity provider. +`experimental `_: Revokes the JWKS tokens from the requested OIDC identity provider. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. Note: Revoking your JWKS tokens immediately refreshes your IdP public keys from all your Atlas clusters, invalidating previously signed access tokens and logging out all users. You may need to restart your MongoDB clients. All organizations connected to the identity provider will be affected. To learn more, see Configure OIDC Authorization. This command is invoking the endpoint with OperationID: 'revokeJwksFromIdentityProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/revokeJwksFromIdentityProvider diff --git a/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt b/docs/command/atlas-api-federatedAuthentication-updateConnectedOrgConfig.txt index 704f4741b5..8029af04b7 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 -`experimental `: Updates one connected organization configuration from the specified federation. +`experimental `_: Updates one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. Note If the organization configuration has no associated identity provider, you can't use this resource to update role mappings or post authorization role grants. Note: The domainRestrictionEnabled field defaults to false if not provided in the request. Note: If the identityProviderId field is not provided, you will disconnect the organization and the identity provider. Note: Currently connected data access identity providers missing from the dataAccessIdentityProviderIds field will be disconnected. This command is invoking the endpoint with OperationID: 'updateConnectedOrgConfig'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig diff --git a/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt b/docs/command/atlas-api-federatedAuthentication-updateIdentityProvider.txt index 3801a5f6be..a85398764f 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 -`experimental `: Updates one identity provider in the specified federation. +`experimental `_: Updates one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. Note: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database. This command is invoking the endpoint with OperationID: 'updateIdentityProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateIdentityProvider diff --git a/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt b/docs/command/atlas-api-federatedAuthentication-updateRoleMapping.txt index 0a341ecd48..904257d623 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 -`experimental `: Updates one role mapping in the specified organization in the specified federation. +`experimental `_: Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'updateRoleMapping'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateRoleMapping diff --git a/docs/command/atlas-api-federatedAuthentication.txt b/docs/command/atlas-api-federatedAuthentication.txt index 470cf98cbe..92b2841a9a 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 -`experimental `: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. +`experimental `_: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. Options ------- @@ -49,24 +49,24 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-federatedAuthentication-createIdentityProvider` - `experimental `: Creates one identity provider within the specified federation. -* :ref:`atlas-api-federatedAuthentication-createRoleMapping` - `experimental `: Adds one role mapping to the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-deleteFederationApp` - `experimental `: Deletes the federation settings instance and all associated data, including identity providers and domains. -* :ref:`atlas-api-federatedAuthentication-deleteIdentityProvider` - `experimental `: Deletes one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-deleteRoleMapping` - `experimental `: Removes one role mapping in the specified organization from the specified federation. -* :ref:`atlas-api-federatedAuthentication-getConnectedOrgConfig` - `experimental `: Returns the specified connected org config from the specified federation. -* :ref:`atlas-api-federatedAuthentication-getFederationSettings` - `experimental `: Returns information about the federation settings for the specified organization. -* :ref:`atlas-api-federatedAuthentication-getIdentityProvider` - `experimental `: Returns one identity provider in the specified federation by the identity provider's id. -* :ref:`atlas-api-federatedAuthentication-getIdentityProviderMetadata` - `experimental `: Returns the metadata of one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-getRoleMapping` - `experimental `: Returns one role mapping from the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listConnectedOrgConfigs` - `experimental `: Returns all connected org configs in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listIdentityProviders` - `experimental `: Returns all identity providers with the provided protocol and type in the specified federation. -* :ref:`atlas-api-federatedAuthentication-listRoleMappings` - `experimental `: Returns all role mappings from the specified organization in the specified federation. -* :ref:`atlas-api-federatedAuthentication-removeConnectedOrgConfig` - `experimental `: Removes one connected organization configuration from the specified federation. -* :ref:`atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider` - `experimental `: Revokes the JWKS tokens from the requested OIDC identity provider. -* :ref:`atlas-api-federatedAuthentication-updateConnectedOrgConfig` - `experimental `: Updates one connected organization configuration from the specified federation. -* :ref:`atlas-api-federatedAuthentication-updateIdentityProvider` - `experimental `: Updates one identity provider in the specified federation. -* :ref:`atlas-api-federatedAuthentication-updateRoleMapping` - `experimental `: Updates one role mapping in the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-createIdentityProvider` - `experimental `_: Creates one identity provider within the specified federation. +* :ref:`atlas-api-federatedAuthentication-createRoleMapping` - `experimental `_: Adds one role mapping to the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-deleteFederationApp` - `experimental `_: Deletes the federation settings instance and all associated data, including identity providers and domains. +* :ref:`atlas-api-federatedAuthentication-deleteIdentityProvider` - `experimental `_: Deletes one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-deleteRoleMapping` - `experimental `_: Removes one role mapping in the specified organization from the specified federation. +* :ref:`atlas-api-federatedAuthentication-getConnectedOrgConfig` - `experimental `_: Returns the specified connected org config from the specified federation. +* :ref:`atlas-api-federatedAuthentication-getFederationSettings` - `experimental `_: Returns information about the federation settings for the specified organization. +* :ref:`atlas-api-federatedAuthentication-getIdentityProvider` - `experimental `_: Returns one identity provider in the specified federation by the identity provider's id. +* :ref:`atlas-api-federatedAuthentication-getIdentityProviderMetadata` - `experimental `_: Returns the metadata of one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-getRoleMapping` - `experimental `_: Returns one role mapping from the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listConnectedOrgConfigs` - `experimental `_: Returns all connected org configs in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listIdentityProviders` - `experimental `_: Returns all identity providers with the provided protocol and type in the specified federation. +* :ref:`atlas-api-federatedAuthentication-listRoleMappings` - `experimental `_: Returns all role mappings from the specified organization in the specified federation. +* :ref:`atlas-api-federatedAuthentication-removeConnectedOrgConfig` - `experimental `_: Removes one connected organization configuration from the specified federation. +* :ref:`atlas-api-federatedAuthentication-revokeJwksFromIdentityProvider` - `experimental `_: Revokes the JWKS tokens from the requested OIDC identity provider. +* :ref:`atlas-api-federatedAuthentication-updateConnectedOrgConfig` - `experimental `_: Updates one connected organization configuration from the specified federation. +* :ref:`atlas-api-federatedAuthentication-updateIdentityProvider` - `experimental `_: Updates one identity provider in the specified federation. +* :ref:`atlas-api-federatedAuthentication-updateRoleMapping` - `experimental `_: 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 e3e7e11e02..80add15a25 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 -`experimental `: Creates one flex cluster in the specified project. +`experimental `_: Creates one flex cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createFlexCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster diff --git a/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt b/docs/command/atlas-api-flexClusters-deleteFlexCluster.txt index d1360a2887..8f4459cc29 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 -`experimental `: Removes one flex cluster from the specified project. +`experimental `_: Removes one flex cluster from the specified project. The flex cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteFlexCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster diff --git a/docs/command/atlas-api-flexClusters-getFlexCluster.txt b/docs/command/atlas-api-flexClusters-getFlexCluster.txt index 292171dfda..11d4839c9f 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 -`experimental `: Returns details for one flex cluster in the specified project. +`experimental `_: Returns details for one flex cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getFlexCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster diff --git a/docs/command/atlas-api-flexClusters-listFlexClusters.txt b/docs/command/atlas-api-flexClusters-listFlexClusters.txt index 38792abbf2..c8d162d3f6 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 -`experimental `: Returns details for all flex clusters in the specified project. +`experimental `_: Returns details for all flex clusters in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listFlexClusters'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters diff --git a/docs/command/atlas-api-flexClusters-updateFlexCluster.txt b/docs/command/atlas-api-flexClusters-updateFlexCluster.txt index aa62df9193..218e6cc468 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 -`experimental `: Updates one flex cluster in the specified project. +`experimental `_: Updates one flex cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateFlexCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateFlexCluster diff --git a/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt b/docs/command/atlas-api-flexClusters-upgradeFlexCluster.txt index 11ac2c5037..8fb8bbf705 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 -`experimental `: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. +`experimental `_: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. This command is invoking the endpoint with OperationID: 'upgradeFlexCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster diff --git a/docs/command/atlas-api-flexClusters.txt b/docs/command/atlas-api-flexClusters.txt index db977268ba..b379d4c90c 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 -`experimental `: Returns, adds, edits, and removes flex clusters. +`experimental `_: Returns, adds, edits, and removes flex clusters. Options ------- @@ -49,12 +49,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexClusters-createFlexCluster` - `experimental `: Creates one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-deleteFlexCluster` - `experimental `: Removes one flex cluster from the specified project. -* :ref:`atlas-api-flexClusters-getFlexCluster` - `experimental `: Returns details for one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-listFlexClusters` - `experimental `: Returns details for all flex clusters in the specified project. -* :ref:`atlas-api-flexClusters-updateFlexCluster` - `experimental `: Updates one flex cluster in the specified project. -* :ref:`atlas-api-flexClusters-upgradeFlexCluster` - `experimental `: Upgrades a flex cluster to a dedicated cluster (M10+) in the specified project. +* :ref:`atlas-api-flexClusters-createFlexCluster` - `experimental `_: Creates one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-deleteFlexCluster` - `experimental `_: Removes one flex cluster from the specified project. +* :ref:`atlas-api-flexClusters-getFlexCluster` - `experimental `_: Returns details for one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-listFlexClusters` - `experimental `_: Returns details for all flex clusters in the specified project. +* :ref:`atlas-api-flexClusters-updateFlexCluster` - `experimental `_: Updates one flex cluster in the specified project. +* :ref:`atlas-api-flexClusters-upgradeFlexCluster` - `experimental `_: 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 76093edbf9..cb09fb077b 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 -`experimental `: Restores one snapshot of one flex cluster from the specified project. +`experimental `_: Restores one snapshot of one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createFlexBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob diff --git a/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt b/docs/command/atlas-api-flexRestoreJobs-getFlexBackupRestoreJob.txt index fb97d3bbf9..9ebfeba304 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 -`experimental `: Returns one restore job for one flex cluster from the specified project. +`experimental `_: Returns one restore job for one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getFlexBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob diff --git a/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs.txt index 72130a627e..d6c5710314 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 -`experimental `: Returns all restore jobs for one flex cluster from the specified project. +`experimental `_: Returns all restore jobs for one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'listFlexBackupRestoreJobs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs diff --git a/docs/command/atlas-api-flexRestoreJobs.txt b/docs/command/atlas-api-flexRestoreJobs.txt index 37c421692f..eef759246e 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 -`experimental `: Returns and adds restore jobs for flex database deployments. +`experimental `_: Returns and adds restore jobs for flex database deployments. Options ------- @@ -49,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexRestoreJobs-createFlexBackupRestoreJob` - `experimental `: Restores one snapshot of one flex cluster from the specified project. -* :ref:`atlas-api-flexRestoreJobs-getFlexBackupRestoreJob` - `experimental `: Returns one restore job for one flex cluster from the specified project. -* :ref:`atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs` - `experimental `: Returns all restore jobs for one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-createFlexBackupRestoreJob` - `experimental `_: Restores one snapshot of one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-getFlexBackupRestoreJob` - `experimental `_: Returns one restore job for one flex cluster from the specified project. +* :ref:`atlas-api-flexRestoreJobs-listFlexBackupRestoreJobs` - `experimental `_: 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 c5fd27462b..914a349674 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 -`experimental `: Requests one snapshot for the specified flex cluster. +`experimental `_: Requests one snapshot for the specified flex cluster. This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'downloadFlexBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup diff --git a/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt b/docs/command/atlas-api-flexSnapshots-getFlexBackup.txt index b0dac6d332..6ddca64343 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 -`experimental `: Returns one snapshot of one flex cluster from the specified project. +`experimental `_: Returns one snapshot of one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getFlexBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup diff --git a/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt b/docs/command/atlas-api-flexSnapshots-listFlexBackups.txt index c6316acc4f..1d662d7104 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 -`experimental `: Returns all snapshots of one flex cluster from the specified project. +`experimental `_: Returns all snapshots of one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listFlexBackups'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups diff --git a/docs/command/atlas-api-flexSnapshots.txt b/docs/command/atlas-api-flexSnapshots.txt index 8ffb12c405..36913b12b8 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 -`experimental `: Returns and requests to download flex database deployment snapshots. +`experimental `_: Returns and requests to download flex database deployment snapshots. Options ------- @@ -49,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-flexSnapshots-downloadFlexBackup` - `experimental `: Requests one snapshot for the specified flex cluster. -* :ref:`atlas-api-flexSnapshots-getFlexBackup` - `experimental `: Returns one snapshot of one flex cluster from the specified project. -* :ref:`atlas-api-flexSnapshots-listFlexBackups` - `experimental `: Returns all snapshots of one flex cluster from the specified project. +* :ref:`atlas-api-flexSnapshots-downloadFlexBackup` - `experimental `_: Requests one snapshot for the specified flex cluster. +* :ref:`atlas-api-flexSnapshots-getFlexBackup` - `experimental `_: Returns one snapshot of one flex cluster from the specified project. +* :ref:`atlas-api-flexSnapshots-listFlexBackups` - `experimental `_: 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 936f1befab..8813729a1e 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 -`experimental `: Creates one custom zone mapping for the specified global cluster. +`experimental `_: Creates one custom zone mapping for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createCustomZoneMapping'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createCustomZoneMapping diff --git a/docs/command/atlas-api-globalClusters-createManagedNamespace.txt b/docs/command/atlas-api-globalClusters-createManagedNamespace.txt index c3e8d45e6b..1d273f3348 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 -`experimental `: Creates one managed namespace within the specified global cluster. +`experimental `_: Creates one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'createManagedNamespace'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createManagedNamespace diff --git a/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt b/docs/command/atlas-api-globalClusters-deleteAllCustomZoneMappings.txt index 0a2c8294e2..faf6ba5a82 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 -`experimental `: Removes all custom zone mappings for the specified global cluster. +`experimental `_: Removes all custom zone mappings for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteAllCustomZoneMappings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteAllCustomZoneMappings diff --git a/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt b/docs/command/atlas-api-globalClusters-deleteManagedNamespace.txt index 38e0949628..b57c3463b9 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 -`experimental `: Removes one managed namespace within the specified global cluster. +`experimental `_: Removes one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'deleteManagedNamespace'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteManagedNamespace diff --git a/docs/command/atlas-api-globalClusters-getManagedNamespace.txt b/docs/command/atlas-api-globalClusters-getManagedNamespace.txt index a47c73c902..1fa70fe29e 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 -`experimental `: Returns one managed namespace within the specified global cluster. +`experimental `_: Returns one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getManagedNamespace'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/getManagedNamespace diff --git a/docs/command/atlas-api-globalClusters.txt b/docs/command/atlas-api-globalClusters.txt index ea99f0d477..fe166ff7f3 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 -`experimental `: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. +`experimental `_: 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. @@ -51,11 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-globalClusters-createCustomZoneMapping` - `experimental `: Creates one custom zone mapping for the specified global cluster. -* :ref:`atlas-api-globalClusters-createManagedNamespace` - `experimental `: Creates one managed namespace within the specified global cluster. -* :ref:`atlas-api-globalClusters-deleteAllCustomZoneMappings` - `experimental `: Removes all custom zone mappings for the specified global cluster. -* :ref:`atlas-api-globalClusters-deleteManagedNamespace` - `experimental `: Removes one managed namespace within the specified global cluster. -* :ref:`atlas-api-globalClusters-getManagedNamespace` - `experimental `: Returns one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-createCustomZoneMapping` - `experimental `_: Creates one custom zone mapping for the specified global cluster. +* :ref:`atlas-api-globalClusters-createManagedNamespace` - `experimental `_: Creates one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-deleteAllCustomZoneMappings` - `experimental `_: Removes all custom zone mappings for the specified global cluster. +* :ref:`atlas-api-globalClusters-deleteManagedNamespace` - `experimental `_: Removes one managed namespace within the specified global cluster. +* :ref:`atlas-api-globalClusters-getManagedNamespace` - `experimental `_: 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 efe6e6b068..3bb9c29ce0 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 -`experimental `: Creates a query process within the Cost Explorer for the given parameters. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'createCostExplorerQueryProcess'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/createCostExplorerQueryProcess diff --git a/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt b/docs/command/atlas-api-invoices-downloadInvoiceCsv.txt index 1151119f90..f033ae6b22 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 -`experimental `: Returns one invoice that MongoDB issued to the specified organization in CSV format. +`experimental `_: Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role. 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. This command is invoking the endpoint with OperationID: 'downloadInvoiceCsv'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/downloadInvoiceCsv diff --git a/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt b/docs/command/atlas-api-invoices-getCostExplorerQueryProcess.txt index 1b504baefa..571523b450 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 -`experimental `: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'getCostExplorerQueryProcess'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getCostExplorerQueryProcess diff --git a/docs/command/atlas-api-invoices-getInvoice.txt b/docs/command/atlas-api-invoices-getInvoice.txt index e954096ed5..119080df2b 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 -`experimental `: Returns one invoice that MongoDB issued to the specified organization. +`experimental `_: Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner role. 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. This command is invoking the endpoint with OperationID: 'getInvoice'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getInvoice diff --git a/docs/command/atlas-api-invoices-listInvoices.txt b/docs/command/atlas-api-invoices-listInvoices.txt index fb4d2034ab..0264f34464 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 -`experimental `: Returns all invoices that MongoDB issued to the specified organization. +`experimental `_: Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner role. 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. This command is invoking the endpoint with OperationID: 'listInvoices'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listInvoices diff --git a/docs/command/atlas-api-invoices-listPendingInvoices.txt b/docs/command/atlas-api-invoices-listPendingInvoices.txt index b590e14b0c..d481457ef7 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 -`experimental `: Returns all invoices accruing charges for the current billing cycle for the specified organization. +`experimental `_: Returns all invoices accruing charges for the current billing cycle for the specified organization. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. This command is invoking the endpoint with OperationID: 'listPendingInvoices'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listPendingInvoices diff --git a/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt b/docs/command/atlas-api-invoices-queryLineItemsFromSingleInvoice.txt index d9bb458185..ccaceb674c 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 -`experimental `: Query the lineItems of the specified invoice and return the result JSON. +`experimental `_: Query the lineItems of the specified invoice and return the result JSON. A unique 24-hexadecimal digit string identifies the invoice. This command is invoking the endpoint with OperationID: 'queryLineItemsFromSingleInvoice'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/queryLineItemsFromSingleInvoice diff --git a/docs/command/atlas-api-invoices.txt b/docs/command/atlas-api-invoices.txt index 7dd3d1988a..8ce17b1b7f 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 -`experimental `: Returns invoices. +`experimental `_: Returns invoices. Options ------- @@ -49,13 +49,13 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-invoices-createCostExplorerQueryProcess` - `experimental `: Creates a query process within the Cost Explorer for the given parameters. -* :ref:`atlas-api-invoices-downloadInvoiceCsv` - `experimental `: Returns one invoice that MongoDB issued to the specified organization in CSV format. -* :ref:`atlas-api-invoices-getCostExplorerQueryProcess` - `experimental `: 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` - `experimental `: Returns one invoice that MongoDB issued to the specified organization. -* :ref:`atlas-api-invoices-listInvoices` - `experimental `: Returns all invoices that MongoDB issued to the specified organization. -* :ref:`atlas-api-invoices-listPendingInvoices` - `experimental `: Returns all invoices accruing charges for the current billing cycle for the specified organization. -* :ref:`atlas-api-invoices-queryLineItemsFromSingleInvoice` - `experimental `: Query the lineItems of the specified invoice and return the result JSON. +* :ref:`atlas-api-invoices-createCostExplorerQueryProcess` - `experimental `_: Creates a query process within the Cost Explorer for the given parameters. +* :ref:`atlas-api-invoices-downloadInvoiceCsv` - `experimental `_: Returns one invoice that MongoDB issued to the specified organization in CSV format. +* :ref:`atlas-api-invoices-getCostExplorerQueryProcess` - `experimental `_: 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` - `experimental `_: Returns one invoice that MongoDB issued to the specified organization. +* :ref:`atlas-api-invoices-listInvoices` - `experimental `_: Returns all invoices that MongoDB issued to the specified organization. +* :ref:`atlas-api-invoices-listPendingInvoices` - `experimental `_: Returns all invoices accruing charges for the current billing cycle for the specified organization. +* :ref:`atlas-api-invoices-queryLineItemsFromSingleInvoice` - `experimental `_: 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 e07971c7c9..eb5e256ec7 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 -`experimental `: Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. +`experimental `_: Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteLdapConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/deleteLdapConfiguration diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfiguration.txt index 7774fcbd8f..b6772a51a1 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 -`experimental `: Returns the current LDAP configuration for the specified project. +`experimental `_: Returns the current LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getLdapConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfiguration diff --git a/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt b/docs/command/atlas-api-ldapConfiguration-getLdapConfigurationStatus.txt index d15aa2ebba..ce17c3526f 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 -`experimental `: Returns the status of one request to verify one LDAP configuration for the specified project. +`experimental `_: Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getLdapConfigurationStatus'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfigurationStatus diff --git a/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-saveLdapConfiguration.txt index a3724aa73d..dd1c7310d3 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 -`experimental `: Edits the LDAP configuration for the specified project. +`experimental `_: Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. Updating this configuration triggers a rolling restart of the database. This command is invoking the endpoint with OperationID: 'saveLdapConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/saveLdapConfiguration diff --git a/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration-verifyLdapConfiguration.txt index 817309cfcf..3d8ede48f2 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 -`experimental `: Verifies the LDAP configuration for the specified project. +`experimental `_: Verifies the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'verifyLdapConfiguration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/verifyLdapConfiguration diff --git a/docs/command/atlas-api-ldapConfiguration.txt b/docs/command/atlas-api-ldapConfiguration.txt index 25b743d623..4133313a24 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 -`experimental `: Returns, edits, verifies, and removes LDAP configurations. +`experimental `_: 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 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-ldapConfiguration-deleteLdapConfiguration` - `experimental `: 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` - `experimental `: Returns the current LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-getLdapConfigurationStatus` - `experimental `: Returns the status of one request to verify one LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-saveLdapConfiguration` - `experimental `: Edits the LDAP configuration for the specified project. -* :ref:`atlas-api-ldapConfiguration-verifyLdapConfiguration` - `experimental `: Verifies the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-deleteLdapConfiguration` - `experimental `_: 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` - `experimental `_: Returns the current LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-getLdapConfigurationStatus` - `experimental `_: Returns the status of one request to verify one LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-saveLdapConfiguration` - `experimental `_: Edits the LDAP configuration for the specified project. +* :ref:`atlas-api-ldapConfiguration-verifyLdapConfiguration` - `experimental `_: 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 5be9f6a45d..7b320f645b 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 -`experimental `: Restores one legacy backup for one cluster in the specified project. +`experimental `_: Restores one legacy backup for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying delivery.methodName of AUTOMATED_RESTORE in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. This command is invoking the endpoint with OperationID: 'createLegacyBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/createLegacyBackupRestoreJob diff --git a/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-deleteLegacySnapshot.txt index 520006b5a8..25e2fbe7cb 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 -`experimental `: Removes one legacy backup snapshot for one cluster in the specified project. +`experimental `_: Removes one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'deleteLegacySnapshot'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/deleteLegacySnapshot diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupCheckpoint.txt index ac72502a09..66fc06dea5 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 -`experimental `: Returns one legacy backup checkpoint for one cluster in the specified project. +`experimental `_: Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getLegacyBackupCheckpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupCheckpoint diff --git a/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt b/docs/command/atlas-api-legacyBackup-getLegacyBackupRestoreJob.txt index 75b42f40a5..515dfeedc8 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 -`experimental `: Returns one legacy backup restore job for one cluster in the specified project. +`experimental `_: Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'getLegacyBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupRestoreJob diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshot.txt index d79e85b933..5cc9fee8ae 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 -`experimental `: Returns one legacy backup snapshot for one cluster in the specified project. +`experimental `_: Returns one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'getLegacySnapshot'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshot diff --git a/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-getLegacySnapshotSchedule.txt index 1e81e18f62..027a6e47e4 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 -`experimental `: Returns the snapshot schedule for one cluster in the specified project. +`experimental `_: Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'getLegacySnapshotSchedule'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshotSchedule diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupCheckpoints.txt index 71d329146a..f6dc420226 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 -`experimental `: Returns all legacy backup checkpoints for one cluster in the specified project. +`experimental `_: Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listLegacyBackupCheckpoints'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupCheckpoints diff --git a/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt b/docs/command/atlas-api-legacyBackup-listLegacyBackupRestoreJobs.txt index f139d9e222..430e902be5 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 -`experimental `: Returns all legacy backup restore jobs for one cluster in the specified project. +`experimental `_: Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. If you use the BATCH-ID query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set. This command is invoking the endpoint with OperationID: 'listLegacyBackupRestoreJobs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupRestoreJobs diff --git a/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt b/docs/command/atlas-api-legacyBackup-listLegacySnapshots.txt index 16de36aa83..583317b7f5 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 -`experimental `: Returns all legacy backup snapshots for one cluster in the specified project. +`experimental `_: Returns all legacy backup snapshots for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'listLegacySnapshots'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacySnapshots diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotRetention.txt index d2b26fe047..ff15f880fc 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 -`experimental `: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. +`experimental `_: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'updateLegacySnapshotRetention'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotRetention diff --git a/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt b/docs/command/atlas-api-legacyBackup-updateLegacySnapshotSchedule.txt index ecdf4a69d3..2c3a35ea86 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 -`experimental `: Updates the snapshot schedule for one cluster in the specified project. +`experimental `_: Updates the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation. This command is invoking the endpoint with OperationID: 'updateLegacySnapshotSchedule'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotSchedule diff --git a/docs/command/atlas-api-legacyBackup.txt b/docs/command/atlas-api-legacyBackup.txt index eadfc353b0..582cb38669 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 -`experimental `: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. +`experimental `_: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. Options ------- @@ -49,17 +49,17 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-legacyBackup-createLegacyBackupRestoreJob` - `experimental `: Restores one legacy backup for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-deleteLegacySnapshot` - `experimental `: Removes one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacyBackupCheckpoint` - `experimental `: Returns one legacy backup checkpoint for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacyBackupRestoreJob` - `experimental `: Returns one legacy backup restore job for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacySnapshot` - `experimental `: Returns one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-getLegacySnapshotSchedule` - `experimental `: Returns the snapshot schedule for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacyBackupCheckpoints` - `experimental `: Returns all legacy backup checkpoints for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacyBackupRestoreJobs` - `experimental `: Returns all legacy backup restore jobs for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-listLegacySnapshots` - `experimental `: Returns all legacy backup snapshots for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-updateLegacySnapshotRetention` - `experimental `: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. -* :ref:`atlas-api-legacyBackup-updateLegacySnapshotSchedule` - `experimental `: Updates the snapshot schedule for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-createLegacyBackupRestoreJob` - `experimental `_: Restores one legacy backup for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-deleteLegacySnapshot` - `experimental `_: Removes one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacyBackupCheckpoint` - `experimental `_: Returns one legacy backup checkpoint for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacyBackupRestoreJob` - `experimental `_: Returns one legacy backup restore job for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacySnapshot` - `experimental `_: Returns one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-getLegacySnapshotSchedule` - `experimental `_: Returns the snapshot schedule for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacyBackupCheckpoints` - `experimental `_: Returns all legacy backup checkpoints for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacyBackupRestoreJobs` - `experimental `_: Returns all legacy backup restore jobs for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-listLegacySnapshots` - `experimental `_: Returns all legacy backup snapshots for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-updateLegacySnapshotRetention` - `experimental `_: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. +* :ref:`atlas-api-legacyBackup-updateLegacySnapshotSchedule` - `experimental `_: 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 c79be13174..089b391e60 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 -`experimental `: Defers the maintenance window for the specified project. +`experimental `_: Defers the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deferMaintenanceWindow'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/deferMaintenanceWindow diff --git a/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-getMaintenanceWindow.txt index 860c0909f3..84176bab91 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 -`experimental `: Returns the maintenance window for the specified project. +`experimental `_: Returns the maintenance window for the specified project. MongoDB Cloud starts those maintenance activities when needed. You can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getMaintenanceWindow'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/getMaintenanceWindow diff --git a/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-resetMaintenanceWindow.txt index 0324c25763..19dc7e8230 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 -`experimental `: Resets the maintenance window for the specified project. +`experimental `_: Resets the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'resetMaintenanceWindow'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/resetMaintenanceWindow diff --git a/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt b/docs/command/atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer.txt index 8df7a339b9..2ba33935ae 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 -`experimental `: Toggles automatic deferral of the maintenance window for the specified project. +`experimental `_: Toggles automatic deferral of the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'toggleMaintenanceAutoDefer'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/toggleMaintenanceAutoDefer diff --git a/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt b/docs/command/atlas-api-maintenanceWindows-updateMaintenanceWindow.txt index 4eb20605b3..d713f7e93c 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 -`experimental `: Updates the maintenance window for the specified project. +`experimental `_: Updates the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateMaintenanceWindow'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/updateMaintenanceWindow diff --git a/docs/command/atlas-api-maintenanceWindows.txt b/docs/command/atlas-api-maintenanceWindows.txt index 35c9a3972b..f9fa68e16e 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 -`experimental `: Returns, edits, and removes maintenance windows. +`experimental `_: 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 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-maintenanceWindows-deferMaintenanceWindow` - `experimental `: Defers the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-getMaintenanceWindow` - `experimental `: Returns the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-resetMaintenanceWindow` - `experimental `: Resets the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer` - `experimental `: Toggles automatic deferral of the maintenance window for the specified project. -* :ref:`atlas-api-maintenanceWindows-updateMaintenanceWindow` - `experimental `: Updates the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-deferMaintenanceWindow` - `experimental `_: Defers the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-getMaintenanceWindow` - `experimental `_: Returns the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-resetMaintenanceWindow` - `experimental `_: Resets the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-toggleMaintenanceAutoDefer` - `experimental `_: Toggles automatic deferral of the maintenance window for the specified project. +* :ref:`atlas-api-maintenanceWindows-updateMaintenanceWindow` - `experimental `_: 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 22fcfebade..fd35e8b0b5 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 -`experimental `: Adds one organization-level role to the MongoDB Cloud user. +`experimental `_: Adds one organization-level role to the MongoDB Cloud user. You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role. Note: This operation is atomic. Note: This resource cannot be used to add a role to users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'addOrganizationRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addOrganizationRole diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-addProjectRole.txt index 77504bed11..0dd3774fa1 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 -`experimental `: Adds one project-level role to the MongoDB Cloud user. +`experimental `_: 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 API Key must have the Project Owner role. Note: This resource cannot be used to add a role to users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'addProjectRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectRole diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-addProjectUser.txt index 069f758bde..08b97d0118 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 -`experimental `: Adds one MongoDB Cloud user to one project. +`experimental `_: Adds one MongoDB Cloud user to one project. To use this resource, the requesting API Key must have the Group User Admin role. If the user has a pending invitation to join the project's organization, MongoDB Cloud modifies it and grants project access. If the user doesn't have an invitation to join the organization, MongoDB Cloud sends a new invitation that grants the user organization and project access. If the user is already active in the project's organization, MongoDB Cloud grants access to the project. This command is invoking the endpoint with OperationID: 'addProjectUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt b/docs/command/atlas-api-mongoDbCloudUsers-addUserToTeam.txt index c8151181ed..d69ca99c9d 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 -`experimental `: Adds one MongoDB Cloud user to one team. +`experimental `_: 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 API Key must have the Organization Owner role. Note: This resource cannot be used to add a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'addUserToTeam'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addUserToTeam diff --git a/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-createOrganizationUser.txt index 1fcc2fb75e..099855ce1c 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 -`experimental `: Invites one new or existing MongoDB Cloud user to join the organization. +`experimental `_: Invites one new or existing MongoDB Cloud user to join the organization. The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting API Key must have the Organization Owner role. Note: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization. This command is invoking the endpoint with OperationID: 'createOrganizationUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createOrganizationUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-createUser.txt index ab9709aa0a..6bd36c3e32 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 -`experimental `: Creates one MongoDB Cloud user account. +`experimental `_: Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days. MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization. To use this resource, the requesting API Key can have any role. This command is invoking the endpoint with OperationID: 'createUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getOrganizationUser.txt index e2c7f8bf91..8eff513f96 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 -`experimental `: Returns information about the specified MongoDB Cloud user within the context of the specified organization. +`experimental `_: Returns information about the specified MongoDB Cloud user within the context of the specified organization. To use this resource, the requesting API Key must have the Organization Read Only role. Note: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the Return One Organization API Key endpoint. Note: This resource does not return information about pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'getOrganizationUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getOrganizationUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getProjectUser.txt index a35688de7e..c1a44a3527 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 -`experimental `: Returns information about the specified MongoDB Cloud user within the context of the specified project. +`experimental `_: Returns information about the specified MongoDB Cloud user within the context of the specified project. To use this resource, the requesting API Key must have the Group Read Only role. Note: You can only use this resource to fetch information about MongoDB Cloud human users. To return information about an API Key, use the Return One Organization API Key endpoint. Note: This resource does not return information about pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'getProjectUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getProjectUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUser.txt index f64aa499e9..9e8dcae0b9 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 -`experimental `: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. +`experimental `_: 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 API Key can have any role. This command is invoking the endpoint with OperationID: 'getUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt b/docs/command/atlas-api-mongoDbCloudUsers-getUserByUsername.txt index 4e5b270210..99d0b8b4b2 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 -`experimental `: Returns the details for one MongoDB Cloud user account with the specified username. +`experimental `_: 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 API Key can have any role. This command is invoking the endpoint with OperationID: 'getUserByUsername'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUserByUsername diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeOrganizationRole.txt index 0a89516a34..a0219c8ddc 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 -`experimental `: Removes one organization-level role from the MongoDB Cloud user. +`experimental `_: Removes one organization-level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting API Key must have the Organization Owner role. Note: This operation is atomic. Note: This resource cannot be used to remove a role from users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'removeOrganizationRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationRole diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeProjectRole.txt index 85c0b6abc6..92cf43a63e 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 -`experimental `: Removes one project-level role from the MongoDB Cloud user. +`experimental `_: 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 API Key must have the Project Owner role. Note: This resource cannot be used to remove a role from users invited using the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'removeProjectRole'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectRole diff --git a/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt b/docs/command/atlas-api-mongoDbCloudUsers-removeUserFromTeam.txt index 8141ed99d6..ed69d87183 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 -`experimental `: Removes one MongoDB Cloud user from one team. +`experimental `_: 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 API Key must have the Organization Owner role. Note: This resource cannot be used to remove a user invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'removeUserFromTeam'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeUserFromTeam diff --git a/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt b/docs/command/atlas-api-mongoDbCloudUsers-updateOrganizationUser.txt index 5936c69fd8..171b860018 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 -`experimental `: Updates one MongoDB Cloud user in the specified organization. +`experimental `_: Updates one MongoDB Cloud user in the specified organization. You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role. Note: Only include the fields you wish to update in the request body. Supplying a field with an empty value will reset that field on the user. Note: This resource cannot be used to update pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'updateOrganizationUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrganizationUser diff --git a/docs/command/atlas-api-mongoDbCloudUsers.txt b/docs/command/atlas-api-mongoDbCloudUsers.txt index 883fe7baf7..27f1c047e2 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 -`experimental `: Returns, adds, and edits MongoDB Cloud users. +`experimental `_: Returns, adds, and edits MongoDB Cloud users. Options ------- @@ -49,20 +49,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-mongoDbCloudUsers-addOrganizationRole` - `experimental `: Adds one organization-level role to the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-addProjectRole` - `experimental `: Adds one project-level role to the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-addProjectUser` - `experimental `: Adds one MongoDB Cloud user to one project. -* :ref:`atlas-api-mongoDbCloudUsers-addUserToTeam` - `experimental `: Adds one MongoDB Cloud user to one team. -* :ref:`atlas-api-mongoDbCloudUsers-createOrganizationUser` - `experimental `: Invites one new or existing MongoDB Cloud user to join the organization. -* :ref:`atlas-api-mongoDbCloudUsers-createUser` - `experimental `: Creates one MongoDB Cloud user account. -* :ref:`atlas-api-mongoDbCloudUsers-getOrganizationUser` - `experimental `: Returns information about the specified MongoDB Cloud user within the context of the specified organization. -* :ref:`atlas-api-mongoDbCloudUsers-getProjectUser` - `experimental `: Returns information about the specified MongoDB Cloud user within the context of the specified project. -* :ref:`atlas-api-mongoDbCloudUsers-getUser` - `experimental `: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. -* :ref:`atlas-api-mongoDbCloudUsers-getUserByUsername` - `experimental `: Returns the details for one MongoDB Cloud user account with the specified username. -* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationRole` - `experimental `: Removes one organization-level role from the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-removeProjectRole` - `experimental `: Removes one project-level role from the MongoDB Cloud user. -* :ref:`atlas-api-mongoDbCloudUsers-removeUserFromTeam` - `experimental `: Removes one MongoDB Cloud user from one team. -* :ref:`atlas-api-mongoDbCloudUsers-updateOrganizationUser` - `experimental `: Updates one MongoDB Cloud user in the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-addOrganizationRole` - `experimental `_: Adds one organization-level role to the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-addProjectRole` - `experimental `_: Adds one project-level role to the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-addProjectUser` - `experimental `_: Adds one MongoDB Cloud user to one project. +* :ref:`atlas-api-mongoDbCloudUsers-addUserToTeam` - `experimental `_: Adds one MongoDB Cloud user to one team. +* :ref:`atlas-api-mongoDbCloudUsers-createOrganizationUser` - `experimental `_: Invites one new or existing MongoDB Cloud user to join the organization. +* :ref:`atlas-api-mongoDbCloudUsers-createUser` - `experimental `_: Creates one MongoDB Cloud user account. +* :ref:`atlas-api-mongoDbCloudUsers-getOrganizationUser` - `experimental `_: Returns information about the specified MongoDB Cloud user within the context of the specified organization. +* :ref:`atlas-api-mongoDbCloudUsers-getProjectUser` - `experimental `_: Returns information about the specified MongoDB Cloud user within the context of the specified project. +* :ref:`atlas-api-mongoDbCloudUsers-getUser` - `experimental `_: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. +* :ref:`atlas-api-mongoDbCloudUsers-getUserByUsername` - `experimental `_: Returns the details for one MongoDB Cloud user account with the specified username. +* :ref:`atlas-api-mongoDbCloudUsers-removeOrganizationRole` - `experimental `_: Removes one organization-level role from the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-removeProjectRole` - `experimental `_: Removes one project-level role from the MongoDB Cloud user. +* :ref:`atlas-api-mongoDbCloudUsers-removeUserFromTeam` - `experimental `_: Removes one MongoDB Cloud user from one team. +* :ref:`atlas-api-mongoDbCloudUsers-updateOrganizationUser` - `experimental `_: 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 d8cf8c3fbd..d994e9117d 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 -`experimental `: Returns the processes for the specified host for the specified project. +`experimental `_: Returns the processes for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getAtlasProcess'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getAtlasProcess diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabase.txt index eae6d5a365..2f72aa7701 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 -`experimental `: Returns one database running on the specified host for the specified project. +`experimental `_: Returns one database running on the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getDatabase'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabase diff --git a/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDatabaseMeasurements.txt index 33eebc745a..19b7ee3969 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 -`experimental `: Returns the measurements of one database for the specified host for the specified project. +`experimental `_: Returns the measurements of one database for the specified host for the specified project. Returns the database's on-disk storage space based on the MongoDB dbStats command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getDatabaseMeasurements'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabaseMeasurements diff --git a/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getDiskMeasurements.txt index 7a15b4c336..ac7b466d0a 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 -`experimental `: Returns the measurements of one disk or partition for the specified host for the specified project. +`experimental `_: 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 df951e50e0..3006a002d0 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 -`experimental `: Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. +`experimental `_: 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 API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". This command is invoking the endpoint with OperationID: 'getHostLogs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostLogs diff --git a/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getHostMeasurements.txt index b1e937f017..754aeb6722 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 -`experimental `: Returns disk, partition, or host measurements per process for the specified host for the specified project. +`experimental `_: 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 0b4ffcf8bf..dee52f47f9 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 -`experimental `: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'getIndexMetrics'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getIndexMetrics diff --git a/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-getMeasurements.txt index 1d422b7732..32a4b125e2 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 -`experimental `: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'getMeasurements'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getMeasurements diff --git a/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt b/docs/command/atlas-api-monitoringAndLogs-listAtlasProcesses.txt index e89bc5e0fa..8ffbfd2548 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 -`experimental `: Returns details of all processes for the specified project. +`experimental `_: Returns details of all processes for the specified project. A MongoDB process can be either a mongod or mongos. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listAtlasProcesses'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listAtlasProcesses diff --git a/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt b/docs/command/atlas-api-monitoringAndLogs-listDatabases.txt index a74118a17e..77024082b7 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 -`experimental `: Returns the list of databases running on the specified host for the specified project. +`experimental `_: Returns the list of databases running on the specified host for the specified project. M0 free clusters, M2, M5, and serverless clusters have some operational limits. The MongoDB Cloud process must be a mongod. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listDatabases'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDatabases diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskMeasurements.txt index f52db7a899..5765faa028 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 -`experimental `: Returns measurement details for one disk or partition for the specified host for the specified project. +`experimental `_: Returns measurement details for one disk or partition for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listDiskMeasurements'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskMeasurements diff --git a/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt b/docs/command/atlas-api-monitoringAndLogs-listDiskPartitions.txt index 972efb8d28..f1bb1ed3cf 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 -`experimental `: Returns the list of disks or partitions for the specified host for the specified project. +`experimental `_: Returns the list of disks or partitions for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listDiskPartitions'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskPartitions diff --git a/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt b/docs/command/atlas-api-monitoringAndLogs-listIndexMetrics.txt index fd6d36cdbd..6d56a940c1 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 -`experimental `: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. +`experimental `_: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. This command is invoking the endpoint with OperationID: 'listIndexMetrics'. For more information about flags, format of --file and examples, see: 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 3fd705a22d..8628d13bb6 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 -`experimental `: Returns all Atlas Search metric types available for one process in the specified project. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'listMetricTypes'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listMetricTypes diff --git a/docs/command/atlas-api-monitoringAndLogs.txt b/docs/command/atlas-api-monitoringAndLogs.txt index d18374086e..e7d237139b 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 -`experimental `: Returns database deployment monitoring and logging data. +`experimental `_: Returns database deployment monitoring and logging data. Options ------- @@ -49,20 +49,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-monitoringAndLogs-getAtlasProcess` - `experimental `: Returns the processes for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDatabase` - `experimental `: Returns one database running on the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDatabaseMeasurements` - `experimental `: Returns the measurements of one database for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getDiskMeasurements` - `experimental `: Returns the measurements of one disk or partition for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getHostLogs` - `experimental `: 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` - `experimental `: Returns disk, partition, or host measurements per process for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-getIndexMetrics` - `experimental `: 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` - `experimental `: 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` - `experimental `: Returns details of all processes for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDatabases` - `experimental `: Returns the list of databases running on the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDiskMeasurements` - `experimental `: Returns measurement details for one disk or partition for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listDiskPartitions` - `experimental `: Returns the list of disks or partitions for the specified host for the specified project. -* :ref:`atlas-api-monitoringAndLogs-listIndexMetrics` - `experimental `: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. -* :ref:`atlas-api-monitoringAndLogs-listMetricTypes` - `experimental `: Returns all Atlas Search metric types available for one process in the specified project. +* :ref:`atlas-api-monitoringAndLogs-getAtlasProcess` - `experimental `_: Returns the processes for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDatabase` - `experimental `_: Returns one database running on the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDatabaseMeasurements` - `experimental `_: Returns the measurements of one database for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getDiskMeasurements` - `experimental `_: Returns the measurements of one disk or partition for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getHostLogs` - `experimental `_: 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` - `experimental `_: Returns disk, partition, or host measurements per process for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-getIndexMetrics` - `experimental `_: 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` - `experimental `_: 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` - `experimental `_: Returns details of all processes for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDatabases` - `experimental `_: Returns the list of databases running on the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDiskMeasurements` - `experimental `_: Returns measurement details for one disk or partition for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listDiskPartitions` - `experimental `_: Returns the list of disks or partitions for the specified host for the specified project. +* :ref:`atlas-api-monitoringAndLogs-listIndexMetrics` - `experimental `_: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. +* :ref:`atlas-api-monitoringAndLogs-listMetricTypes` - `experimental `_: 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 39a82ce275..83665eeed4 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 -`experimental `: Creates one new network peering connection in the specified project. +`experimental `_: Creates one new network peering connection in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. This command is invoking the endpoint with OperationID: 'createPeeringConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringConnection diff --git a/docs/command/atlas-api-networkPeering-createPeeringContainer.txt b/docs/command/atlas-api-networkPeering-createPeeringContainer.txt index 49d9e88028..b0424f8e0d 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 -`experimental `: Creates one new network peering container in the specified project. +`experimental `_: Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createPeeringContainer'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringContainer diff --git a/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt b/docs/command/atlas-api-networkPeering-deletePeeringConnection.txt index 395d5b5bf1..50b7bd8207 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 -`experimental `: Removes one network peering connection in the specified project. +`experimental `_: Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deletePeeringConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringConnection diff --git a/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt b/docs/command/atlas-api-networkPeering-deletePeeringContainer.txt index 235554ddf6..d46c8c4716 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 -`experimental `: Removes one network peering container in the specified project. +`experimental `_: Removes one network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deletePeeringContainer'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringContainer diff --git a/docs/command/atlas-api-networkPeering-disablePeering.txt b/docs/command/atlas-api-networkPeering-disablePeering.txt index f51872df02..4ca3b24672 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 -`experimental `: Disables Connect via Peering Only mode for the specified project. +`experimental `_: Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'disablePeering'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/disablePeering diff --git a/docs/command/atlas-api-networkPeering-getPeeringConnection.txt b/docs/command/atlas-api-networkPeering-getPeeringConnection.txt index 29bc2ae999..0460af8887 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 -`experimental `: Returns details about one specified network peering connection in the specified project. +`experimental `_: Returns details about one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPeeringConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringConnection diff --git a/docs/command/atlas-api-networkPeering-getPeeringContainer.txt b/docs/command/atlas-api-networkPeering-getPeeringContainer.txt index 0fc49f2d62..cb1e4e89b3 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 -`experimental `: Returns details about one network peering container in one specified project. +`experimental `_: Returns details about one network peering container in one specified project. Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPeeringContainer'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringContainer diff --git a/docs/command/atlas-api-networkPeering-listPeeringConnections.txt b/docs/command/atlas-api-networkPeering-listPeeringConnections.txt index fe9af28d0a..9c566f3450 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 -`experimental `: Returns details about all network peering connections in the specified project. +`experimental `_: Returns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPeeringConnections'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringConnections diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt b/docs/command/atlas-api-networkPeering-listPeeringContainerByCloudProvider.txt index d03bc578fd..edac954b95 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 -`experimental `: Returns details about all network peering containers in the specified project for the specified cloud provider. +`experimental `_: Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPeeringContainerByCloudProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainerByCloudProvider diff --git a/docs/command/atlas-api-networkPeering-listPeeringContainers.txt b/docs/command/atlas-api-networkPeering-listPeeringContainers.txt index 10436e1ac8..5be5ed03d0 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 -`experimental `: Returns details about all network peering containers in the specified project. +`experimental `_: Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPeeringContainers'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainers diff --git a/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt b/docs/command/atlas-api-networkPeering-updatePeeringConnection.txt index 6db31ce7f8..63712b9f92 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 -`experimental `: Updates one specified network peering connection in the specified project. +`experimental `_: Updates one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updatePeeringConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringConnection diff --git a/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt b/docs/command/atlas-api-networkPeering-updatePeeringContainer.txt index 9a556011db..094155a399 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 -`experimental `: Updates the network details and labels of one specified network peering container in the specified project. +`experimental `_: Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updatePeeringContainer'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringContainer diff --git a/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt b/docs/command/atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject.txt index 3f2b26b384..072373fbb1 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 -`experimental `: Verifies if someone set the specified project to Connect via Peering Only mode. +`experimental `_: Verifies if someone set the specified project to Connect via Peering Only mode. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'verifyConnectViaPeeringOnlyModeForOneProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/verifyConnectViaPeeringOnlyModeForOneProject diff --git a/docs/command/atlas-api-networkPeering.txt b/docs/command/atlas-api-networkPeering.txt index c39729d6b1..0b4232e413 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 -`experimental `: Returns, adds, edits, and removes network peering containers and peering connections. +`experimental `_: 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 +51,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-networkPeering-createPeeringConnection` - `experimental `: Creates one new network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-createPeeringContainer` - `experimental `: Creates one new network peering container in the specified project. -* :ref:`atlas-api-networkPeering-deletePeeringConnection` - `experimental `: Removes one network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-deletePeeringContainer` - `experimental `: Removes one network peering container in the specified project. -* :ref:`atlas-api-networkPeering-disablePeering` - `experimental `: Disables Connect via Peering Only mode for the specified project. -* :ref:`atlas-api-networkPeering-getPeeringConnection` - `experimental `: Returns details about one specified network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-getPeeringContainer` - `experimental `: Returns details about one network peering container in one specified project. -* :ref:`atlas-api-networkPeering-listPeeringConnections` - `experimental `: Returns details about all network peering connections in the specified project. -* :ref:`atlas-api-networkPeering-listPeeringContainerByCloudProvider` - `experimental `: Returns details about all network peering containers in the specified project for the specified cloud provider. -* :ref:`atlas-api-networkPeering-listPeeringContainers` - `experimental `: Returns details about all network peering containers in the specified project. -* :ref:`atlas-api-networkPeering-updatePeeringConnection` - `experimental `: Updates one specified network peering connection in the specified project. -* :ref:`atlas-api-networkPeering-updatePeeringContainer` - `experimental `: Updates the network details and labels of one specified network peering container in the specified project. -* :ref:`atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject` - `experimental `: Verifies if someone set the specified project to Connect via Peering Only mode. +* :ref:`atlas-api-networkPeering-createPeeringConnection` - `experimental `_: Creates one new network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-createPeeringContainer` - `experimental `_: Creates one new network peering container in the specified project. +* :ref:`atlas-api-networkPeering-deletePeeringConnection` - `experimental `_: Removes one network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-deletePeeringContainer` - `experimental `_: Removes one network peering container in the specified project. +* :ref:`atlas-api-networkPeering-disablePeering` - `experimental `_: Disables Connect via Peering Only mode for the specified project. +* :ref:`atlas-api-networkPeering-getPeeringConnection` - `experimental `_: Returns details about one specified network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-getPeeringContainer` - `experimental `_: Returns details about one network peering container in one specified project. +* :ref:`atlas-api-networkPeering-listPeeringConnections` - `experimental `_: Returns details about all network peering connections in the specified project. +* :ref:`atlas-api-networkPeering-listPeeringContainerByCloudProvider` - `experimental `_: Returns details about all network peering containers in the specified project for the specified cloud provider. +* :ref:`atlas-api-networkPeering-listPeeringContainers` - `experimental `_: Returns details about all network peering containers in the specified project. +* :ref:`atlas-api-networkPeering-updatePeeringConnection` - `experimental `_: Updates one specified network peering connection in the specified project. +* :ref:`atlas-api-networkPeering-updatePeeringContainer` - `experimental `_: Updates the network details and labels of one specified network peering container in the specified project. +* :ref:`atlas-api-networkPeering-verifyConnectViaPeeringOnlyModeForOneProject` - `experimental `_: 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 39d3988e99..6471366298 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 -`experimental `: Creates one online archive. +`experimental `_: Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'createOnlineArchive'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/createOnlineArchive diff --git a/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-deleteOnlineArchive.txt index 18cce1776a..9ba14ae514 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 -`experimental `: Removes one online archive. +`experimental `_: Removes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'deleteOnlineArchive'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/deleteOnlineArchive diff --git a/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt b/docs/command/atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs.txt index 9b9206da75..8dfef6bae3 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 -`experimental `: Downloads query logs for the specified online archive. +`experimental `_: Downloads query logs for the specified online archive. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". This command is invoking the endpoint with OperationID: 'downloadOnlineArchiveQueryLogs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadOnlineArchiveQueryLogs diff --git a/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-getOnlineArchive.txt index b984e38a8a..7c87160a00 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 -`experimental `: Returns one online archive for one cluster. +`experimental `_: Returns one online archive for one cluster. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getOnlineArchive'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/getOnlineArchive diff --git a/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt b/docs/command/atlas-api-onlineArchive-listOnlineArchives.txt index 19f9986353..acdb323d5c 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 -`experimental `: Returns details of all online archives. +`experimental `_: Returns details of all online archives. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listOnlineArchives'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/listOnlineArchives diff --git a/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt b/docs/command/atlas-api-onlineArchive-updateOnlineArchive.txt index 8b1449d9da..15cba8939e 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 -`experimental `: Updates, pauses, or resumes one online archive. +`experimental `_: Updates, pauses, or resumes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'updateOnlineArchive'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/updateOnlineArchive diff --git a/docs/command/atlas-api-onlineArchive.txt b/docs/command/atlas-api-onlineArchive.txt index f93de7ecba..344ebe1024 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 -`experimental `: Returns, adds, edits, or removes an online archive. +`experimental `_: Returns, adds, edits, or removes an online archive. Options ------- @@ -49,12 +49,12 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-onlineArchive-createOnlineArchive` - `experimental `: Creates one online archive. -* :ref:`atlas-api-onlineArchive-deleteOnlineArchive` - `experimental `: Removes one online archive. -* :ref:`atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs` - `experimental `: Downloads query logs for the specified online archive. -* :ref:`atlas-api-onlineArchive-getOnlineArchive` - `experimental `: Returns one online archive for one cluster. -* :ref:`atlas-api-onlineArchive-listOnlineArchives` - `experimental `: Returns details of all online archives. -* :ref:`atlas-api-onlineArchive-updateOnlineArchive` - `experimental `: Updates, pauses, or resumes one online archive. +* :ref:`atlas-api-onlineArchive-createOnlineArchive` - `experimental `_: Creates one online archive. +* :ref:`atlas-api-onlineArchive-deleteOnlineArchive` - `experimental `_: Removes one online archive. +* :ref:`atlas-api-onlineArchive-downloadOnlineArchiveQueryLogs` - `experimental `_: Downloads query logs for the specified online archive. +* :ref:`atlas-api-onlineArchive-getOnlineArchive` - `experimental `_: Returns one online archive for one cluster. +* :ref:`atlas-api-onlineArchive-listOnlineArchives` - `experimental `_: Returns details of all online archives. +* :ref:`atlas-api-onlineArchive-updateOnlineArchive` - `experimental `_: Updates, pauses, or resumes one online archive. .. toctree:: diff --git a/docs/command/atlas-api-openApi-getApiVersions.txt b/docs/command/atlas-api-openApi-getApiVersions.txt index 3db0909fe1..42febf80bc 100644 --- a/docs/command/atlas-api-openApi-getApiVersions.txt +++ b/docs/command/atlas-api-openApi-getApiVersions.txt @@ -12,7 +12,7 @@ atlas api openApi getApiVersions :depth: 1 :class: singlecol -`experimental `: API that provides a list of available versionsfor a given environment. +`experimental `_: API that provides a list of available versionsfor a given environment. This command is invoking the endpoint with OperationID: 'getApiVersions'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/OpenAPI/operation/getApiVersions diff --git a/docs/command/atlas-api-openApi-getOpenApiInfo.txt b/docs/command/atlas-api-openApi-getOpenApiInfo.txt index 323b872211..b3a4320630 100644 --- a/docs/command/atlas-api-openApi-getOpenApiInfo.txt +++ b/docs/command/atlas-api-openApi-getOpenApiInfo.txt @@ -12,7 +12,7 @@ atlas api openApi getOpenApiInfo :depth: 1 :class: singlecol -`experimental `: This resource returns general information about the MongoDB Atlas Administration API OpenAPI Specification. +`experimental `_: This resource returns general information about the MongoDB Atlas Administration API OpenAPI Specification. This command is invoking the endpoint with OperationID: 'getOpenApiInfo'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/OpenAPI/operation/getOpenApiInfo diff --git a/docs/command/atlas-api-openApi.txt b/docs/command/atlas-api-openApi.txt index 9619b50f9c..6c984c9cbf 100644 --- a/docs/command/atlas-api-openApi.txt +++ b/docs/command/atlas-api-openApi.txt @@ -12,7 +12,7 @@ atlas api openApi :depth: 1 :class: singlecol -`experimental `: Returns information about the MongoDB Atlas Specification. +`experimental `_: Returns information about the MongoDB Atlas Specification. Options ------- @@ -49,8 +49,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-openApi-getApiVersions` - `experimental `: API that provides a list of available versionsfor a given environment. -* :ref:`atlas-api-openApi-getOpenApiInfo` - `experimental `: This resource returns general information about the MongoDB Atlas Administration API OpenAPI Specification. +* :ref:`atlas-api-openApi-getApiVersions` - `experimental `_: API that provides a list of available versionsfor a given environment. +* :ref:`atlas-api-openApi-getOpenApiInfo` - `experimental `_: This resource returns general information about the MongoDB Atlas Administration API OpenAPI Specification. .. toctree:: diff --git a/docs/command/atlas-api-organizations-createOrganization.txt b/docs/command/atlas-api-organizations-createOrganization.txt index 0359fe3d97..fba6f4db46 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 -`experimental `: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. +`experimental `_: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. To use this resource, the requesting API Key must have the Organization Owner role. The requesting API Key's organization must be a paying organization. To learn more, see Configure a Paying Organization in the MongoDB Atlas documentation. This command is invoking the endpoint with OperationID: 'createOrganization'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganization diff --git a/docs/command/atlas-api-organizations-createOrganizationInvitation.txt b/docs/command/atlas-api-organizations-createOrganizationInvitation.txt index 9bf799b4e0..a1a54cc8b4 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 -`experimental `: Invites one MongoDB Cloud user to join the specified organization. +`experimental `_: Invites one MongoDB Cloud user to join the specified organization. The user must accept the invitation to access information within the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'createOrganizationInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganizationInvitation diff --git a/docs/command/atlas-api-organizations-deleteOrganization.txt b/docs/command/atlas-api-organizations-deleteOrganization.txt index 9eb19914c9..fec321170f 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 -`experimental `: Removes one specified organization. +`experimental `_: 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 bda545615c..91ccdca423 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 -`experimental `: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. +`experimental `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'deleteOrganizationInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganizationInvitation diff --git a/docs/command/atlas-api-organizations-getOrganization.txt b/docs/command/atlas-api-organizations-getOrganization.txt index e3a033eb0a..00350686e2 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 -`experimental `: Returns one organization to which the requesting API key has access. +`experimental `_: Returns one organization to which the requesting API key has access. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'getOrganization'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganization diff --git a/docs/command/atlas-api-organizations-getOrganizationInvitation.txt b/docs/command/atlas-api-organizations-getOrganizationInvitation.txt index f3fcb2e20f..2a8bb1de6f 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 -`experimental `: Returns the details of one pending invitation to the specified organization. +`experimental `_: Returns the details of one pending invitation to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'getOrganizationInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationInvitation diff --git a/docs/command/atlas-api-organizations-getOrganizationSettings.txt b/docs/command/atlas-api-organizations-getOrganizationSettings.txt index 593356a880..ac633d5069 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 -`experimental `: Returns details about the specified organization's settings. +`experimental `_: Returns details about the specified organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'getOrganizationSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationSettings diff --git a/docs/command/atlas-api-organizations-listOrganizationInvitations.txt b/docs/command/atlas-api-organizations-listOrganizationInvitations.txt index d4480e9340..e1f943c1e4 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 -`experimental `: Returns all pending invitations to the specified organization. +`experimental `_: Returns all pending invitations to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'listOrganizationInvitations'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationInvitations diff --git a/docs/command/atlas-api-organizations-listOrganizationProjects.txt b/docs/command/atlas-api-organizations-listOrganizationProjects.txt index c58d5a919c..b0ae8ca141 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 -`experimental `: Returns multiple projects in the specified organization. +`experimental `_: Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to: diff --git a/docs/command/atlas-api-organizations-listOrganizationUsers.txt b/docs/command/atlas-api-organizations-listOrganizationUsers.txt index 5ec9ec75c7..159db44bdb 100644 --- a/docs/command/atlas-api-organizations-listOrganizationUsers.txt +++ b/docs/command/atlas-api-organizations-listOrganizationUsers.txt @@ -12,7 +12,7 @@ atlas api organizations listOrganizationUsers :depth: 1 :class: singlecol -`experimental `: Returns details about the MongoDB Cloud users associated with the specified organization. +`experimental `_: Returns details about the MongoDB Cloud users associated with the specified organization. Each MongoDB Cloud user returned must belong to the specified organization or to a project within the specified organization. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listOrganizationUsers'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationUsers diff --git a/docs/command/atlas-api-organizations-listOrganizations.txt b/docs/command/atlas-api-organizations-listOrganizations.txt index d4b3cb16d7..143fc167cf 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 -`experimental `: Returns all organizations to which the requesting API Key has access. +`experimental `_: Returns all organizations to which the requesting API Key has access. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listOrganizations'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizations diff --git a/docs/command/atlas-api-organizations-removeOrganizationUser.txt b/docs/command/atlas-api-organizations-removeOrganizationUser.txt index a2b71de1ff..0c37fe1a49 100644 --- a/docs/command/atlas-api-organizations-removeOrganizationUser.txt +++ b/docs/command/atlas-api-organizations-removeOrganizationUser.txt @@ -12,7 +12,7 @@ atlas api organizations removeOrganizationUser :depth: 1 :class: singlecol -`experimental `: Removes one MongoDB Cloud user from the specified organization. +`experimental `_: Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. This command is invoking the endpoint with OperationID: 'removeOrganizationUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/removeOrganizationUser diff --git a/docs/command/atlas-api-organizations-updateOrganization.txt b/docs/command/atlas-api-organizations-updateOrganization.txt index 21243a5f58..6f1da26007 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 -`experimental `: Updates one organization. +`experimental `_: Updates one organization. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'updateOrganization'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganization diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitation.txt index 95fe89008b..eccad9e06b 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 -`experimental `: Updates the details of one pending invitation to the specified organization. +`experimental `_: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the username of the invited user. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'updateOrganizationInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitation diff --git a/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt b/docs/command/atlas-api-organizations-updateOrganizationInvitationById.txt index e4fc04d9e7..56de420a79 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 -`experimental `: Updates the details of one pending invitation to the specified organization. +`experimental `_: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the unique identification string for that invitation. Use the Return All Organization Invitations endpoint to retrieve IDs for all pending organization invitations. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'updateOrganizationInvitationById'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitationById diff --git a/docs/command/atlas-api-organizations-updateOrganizationRoles.txt b/docs/command/atlas-api-organizations-updateOrganizationRoles.txt index 0ccdf8535f..359197f85c 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 -`experimental `: Updates the roles of the specified user in the specified organization. +`experimental `_: Updates the roles of the specified user in the specified organization. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. This command is invoking the endpoint with OperationID: 'updateOrganizationRoles'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationRoles diff --git a/docs/command/atlas-api-organizations-updateOrganizationSettings.txt b/docs/command/atlas-api-organizations-updateOrganizationSettings.txt index fd27a68103..a3427e265e 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 -`experimental `: Updates the organization's settings. +`experimental `_: Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'updateOrganizationSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationSettings diff --git a/docs/command/atlas-api-organizations.txt b/docs/command/atlas-api-organizations.txt index 1919c148b1..a5997802ca 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 -`experimental `: Returns, adds, and edits organizational units in MongoDB Cloud. +`experimental `_: Returns, adds, and edits organizational units in MongoDB Cloud. Options ------- @@ -49,23 +49,23 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-organizations-createOrganization` - `experimental `: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. -* :ref:`atlas-api-organizations-createOrganizationInvitation` - `experimental `: Invites one MongoDB Cloud user to join the specified organization. -* :ref:`atlas-api-organizations-deleteOrganization` - `experimental `: Removes one specified organization. -* :ref:`atlas-api-organizations-deleteOrganizationInvitation` - `experimental `: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. -* :ref:`atlas-api-organizations-getOrganization` - `experimental `: Returns one organization to which the requesting API key has access. -* :ref:`atlas-api-organizations-getOrganizationInvitation` - `experimental `: Returns the details of one pending invitation to the specified organization. -* :ref:`atlas-api-organizations-getOrganizationSettings` - `experimental `: Returns details about the specified organization's settings. -* :ref:`atlas-api-organizations-listOrganizationInvitations` - `experimental `: Returns all pending invitations to the specified organization. -* :ref:`atlas-api-organizations-listOrganizationProjects` - `experimental `: Returns multiple projects in the specified organization. -* :ref:`atlas-api-organizations-listOrganizationUsers` - `experimental `: Returns details about the MongoDB Cloud users associated with the specified organization. -* :ref:`atlas-api-organizations-listOrganizations` - `experimental `: Returns all organizations to which the requesting API Key has access. -* :ref:`atlas-api-organizations-removeOrganizationUser` - `experimental `: Removes one MongoDB Cloud user from the specified organization. -* :ref:`atlas-api-organizations-updateOrganization` - `experimental `: Updates one organization. -* :ref:`atlas-api-organizations-updateOrganizationInvitation` - `experimental `: Updates the details of one pending invitation to the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationInvitationById` - `experimental `: Updates the details of one pending invitation to the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationRoles` - `experimental `: Updates the roles of the specified user in the specified organization. -* :ref:`atlas-api-organizations-updateOrganizationSettings` - `experimental `: Updates the organization's settings. +* :ref:`atlas-api-organizations-createOrganization` - `experimental `_: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. +* :ref:`atlas-api-organizations-createOrganizationInvitation` - `experimental `_: Invites one MongoDB Cloud user to join the specified organization. +* :ref:`atlas-api-organizations-deleteOrganization` - `experimental `_: Removes one specified organization. +* :ref:`atlas-api-organizations-deleteOrganizationInvitation` - `experimental `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. +* :ref:`atlas-api-organizations-getOrganization` - `experimental `_: Returns one organization to which the requesting API key has access. +* :ref:`atlas-api-organizations-getOrganizationInvitation` - `experimental `_: Returns the details of one pending invitation to the specified organization. +* :ref:`atlas-api-organizations-getOrganizationSettings` - `experimental `_: Returns details about the specified organization's settings. +* :ref:`atlas-api-organizations-listOrganizationInvitations` - `experimental `_: Returns all pending invitations to the specified organization. +* :ref:`atlas-api-organizations-listOrganizationProjects` - `experimental `_: Returns multiple projects in the specified organization. +* :ref:`atlas-api-organizations-listOrganizationUsers` - `experimental `_: Returns details about the MongoDB Cloud users associated with the specified organization. +* :ref:`atlas-api-organizations-listOrganizations` - `experimental `_: Returns all organizations to which the requesting API Key has access. +* :ref:`atlas-api-organizations-removeOrganizationUser` - `experimental `_: Removes one MongoDB Cloud user from the specified organization. +* :ref:`atlas-api-organizations-updateOrganization` - `experimental `_: Updates one organization. +* :ref:`atlas-api-organizations-updateOrganizationInvitation` - `experimental `_: Updates the details of one pending invitation to the specified organization. +* :ref:`atlas-api-organizations-updateOrganizationInvitationById` - `experimental `_: Updates the details of one pending invitation to the specified organization. +* :ref:`atlas-api-organizations-updateOrganizationRoles` - `experimental `_: Updates the roles of the specified user in the specified organization. +* :ref:`atlas-api-organizations-updateOrganizationSettings` - `experimental `_: 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 7cbdb8b8e8..fac117655c 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 -`experimental `: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. +`experimental `_: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'disableSlowOperationThresholding'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/disableSlowOperationThresholding diff --git a/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt b/docs/command/atlas-api-performanceAdvisor-enableSlowOperationThresholding.txt index 262dfe4a91..6eac83a71b 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 -`experimental `: Enables MongoDB Cloud to use its slow operation threshold for the specified project. +`experimental `_: Enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'enableSlowOperationThresholding'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/enableSlowOperationThresholding diff --git a/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt b/docs/command/atlas-api-performanceAdvisor-getManagedSlowMs.txt index f57e7d1a85..d7b4133ec4 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 -`experimental `: Get whether the Managed Slow MS feature is enabled. +`experimental `_: Get whether the Managed Slow MS feature is enabled. This command is invoking the endpoint with OperationID: 'getManagedSlowMs'. For more information about flags, format of --file and examples, see: 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 61c6b2c99b..6b478cc906 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 -`experimental `: Get whether the Serverless Auto Indexing feature is enabled. +`experimental `_: Get whether the Serverless Auto Indexing feature is enabled. This command is invoking the endpoint with OperationID: 'getServerlessAutoIndexing'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getServerlessAutoIndexing diff --git a/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listClusterSuggestedIndexes.txt index 342c1654bd..115c94101b 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 -`experimental `: Returns the indexes that the Performance Advisor suggests. +`experimental `_: Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listClusterSuggestedIndexes'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listClusterSuggestedIndexes diff --git a/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listDropIndexes.txt index 86bd3876f3..5fb8c93bfe 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 -`experimental `: Returns the indexes that the Performance Advisor suggests to drop. +`experimental `_: 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 API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listDropIndexes'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listDropIndexes diff --git a/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt b/docs/command/atlas-api-performanceAdvisor-listSchemaAdvice.txt index c1917cce14..7f367c7ede 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 -`experimental `: Returns the schema suggestions that the Performance Advisor detects. +`experimental `_: 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 API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listSchemaAdvice'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSchemaAdvice diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueries.txt index bba001922a..f03be97979 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 -`experimental `: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. +`experimental `_: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'listSlowQueries'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueries diff --git a/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt b/docs/command/atlas-api-performanceAdvisor-listSlowQueryNamespaces.txt index d2004ea5eb..98e381d3fd 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 -`experimental `: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. +`experimental `_: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listSlowQueryNamespaces'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueryNamespaces diff --git a/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt b/docs/command/atlas-api-performanceAdvisor-listSuggestedIndexes.txt index c297a6650f..05d8d5f773 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 -`experimental `: Returns the indexes that the Performance Advisor suggests. +`experimental `_: Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listSuggestedIndexes'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSuggestedIndexes diff --git a/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt b/docs/command/atlas-api-performanceAdvisor-setServerlessAutoIndexing.txt index 82ae8791e8..908c6de326 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 -`experimental `: Set whether the Serverless Auto Indexing feature is enabled. +`experimental `_: Set whether the Serverless Auto Indexing feature is enabled. This command is invoking the endpoint with OperationID: 'setServerlessAutoIndexing'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/setServerlessAutoIndexing diff --git a/docs/command/atlas-api-performanceAdvisor.txt b/docs/command/atlas-api-performanceAdvisor.txt index d27498c966..8a7374df20 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 -`experimental `: Returns suggested indexes and slow query data for a database deployment. +`experimental `_: 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 +51,17 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-performanceAdvisor-disableSlowOperationThresholding` - `experimental `: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. -* :ref:`atlas-api-performanceAdvisor-enableSlowOperationThresholding` - `experimental `: Enables MongoDB Cloud to use its slow operation threshold for the specified project. -* :ref:`atlas-api-performanceAdvisor-getManagedSlowMs` - `experimental `: Get whether the Managed Slow MS feature is enabled. -* :ref:`atlas-api-performanceAdvisor-getServerlessAutoIndexing` - `experimental `: Get whether the Serverless Auto Indexing feature is enabled. -* :ref:`atlas-api-performanceAdvisor-listClusterSuggestedIndexes` - `experimental `: Returns the indexes that the Performance Advisor suggests. -* :ref:`atlas-api-performanceAdvisor-listDropIndexes` - `experimental `: Returns the indexes that the Performance Advisor suggests to drop. -* :ref:`atlas-api-performanceAdvisor-listSchemaAdvice` - `experimental `: Returns the schema suggestions that the Performance Advisor detects. -* :ref:`atlas-api-performanceAdvisor-listSlowQueries` - `experimental `: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. -* :ref:`atlas-api-performanceAdvisor-listSlowQueryNamespaces` - `experimental `: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. -* :ref:`atlas-api-performanceAdvisor-listSuggestedIndexes` - `experimental `: Returns the indexes that the Performance Advisor suggests. -* :ref:`atlas-api-performanceAdvisor-setServerlessAutoIndexing` - `experimental `: Set whether the Serverless Auto Indexing feature is enabled. +* :ref:`atlas-api-performanceAdvisor-disableSlowOperationThresholding` - `experimental `_: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. +* :ref:`atlas-api-performanceAdvisor-enableSlowOperationThresholding` - `experimental `_: Enables MongoDB Cloud to use its slow operation threshold for the specified project. +* :ref:`atlas-api-performanceAdvisor-getManagedSlowMs` - `experimental `_: Get whether the Managed Slow MS feature is enabled. +* :ref:`atlas-api-performanceAdvisor-getServerlessAutoIndexing` - `experimental `_: Get whether the Serverless Auto Indexing feature is enabled. +* :ref:`atlas-api-performanceAdvisor-listClusterSuggestedIndexes` - `experimental `_: Returns the indexes that the Performance Advisor suggests. +* :ref:`atlas-api-performanceAdvisor-listDropIndexes` - `experimental `_: Returns the indexes that the Performance Advisor suggests to drop. +* :ref:`atlas-api-performanceAdvisor-listSchemaAdvice` - `experimental `_: Returns the schema suggestions that the Performance Advisor detects. +* :ref:`atlas-api-performanceAdvisor-listSlowQueries` - `experimental `_: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. +* :ref:`atlas-api-performanceAdvisor-listSlowQueryNamespaces` - `experimental `_: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. +* :ref:`atlas-api-performanceAdvisor-listSuggestedIndexes` - `experimental `_: Returns the indexes that the Performance Advisor suggests. +* :ref:`atlas-api-performanceAdvisor-setServerlessAutoIndexing` - `experimental `_: 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 258244ff48..9543f952c8 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 -`experimental `: Creates one private endpoint for the specified cloud service provider. +`experimental `_: Creates one private endpoint for the specified cloud service provider. This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. This command is invoking the endpoint with OperationID: 'createPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpoint diff --git a/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-createPrivateEndpointService.txt index b4f19d67be..87954cfb5c 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 -`experimental `: Creates one private endpoint service for the specified cloud service provider. +`experimental `_: Creates one private endpoint service for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createPrivateEndpointService'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpointService diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpoint.txt index 733ff14392..eb2746fb5d 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 -`experimental `: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. +`experimental `_: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deletePrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpoint diff --git a/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-deletePrivateEndpointService.txt index 0c33eff02f..214256ab7b 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 -`experimental `: Removes one private endpoint service from the specified project. +`experimental `_: Removes one private endpoint service from the specified project. This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deletePrivateEndpointService'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpointService diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpoint.txt index 7bfd9f4fe7..d995fcf5a0 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 -`experimental `: Returns the connection state of the specified private endpoint. +`experimental `_: Returns the connection state of the specified private endpoint. The private endpoint service manages this private endpoint which belongs to one project hosted from one cloud service provider. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpoint diff --git a/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt b/docs/command/atlas-api-privateEndpointServices-getPrivateEndpointService.txt index d7b67282b5..f86f55ce9d 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 -`experimental `: Returns the name, interfaces, and state of the specified private endpoint service from one project. +`experimental `_: Returns the name, interfaces, and state of the specified private endpoint service from one project. The cloud service provider hosted this private endpoint service that belongs to the project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPrivateEndpointService'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpointService diff --git a/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting.txt index c2d9aab449..8e129c251a 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 -`experimental `: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. +`experimental `_: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. The cloud service provider manages the private endpoint for the project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getRegionalizedPrivateEndpointSetting'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getRegionalizedPrivateEndpointSetting diff --git a/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices-listPrivateEndpointServices.txt index 9a8e9e4c8c..5577594b8e 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 -`experimental `: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. +`experimental `_: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPrivateEndpointServices'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/listPrivateEndpointServices diff --git a/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt b/docs/command/atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting.txt index 6425a14a3c..08cebf7060 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 -`experimental `: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. +`experimental `_: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. The cloud service provider manages the private endpoints for the project. Connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime. To use this resource, the requesting API Key must have the Project Owner role and all clusters in the deployment must be sharded clusters. Once enabled, you cannot create replica sets. This command is invoking the endpoint with OperationID: 'toggleRegionalizedPrivateEndpointSetting'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/toggleRegionalizedPrivateEndpointSetting diff --git a/docs/command/atlas-api-privateEndpointServices.txt b/docs/command/atlas-api-privateEndpointServices.txt index a1431b50bc..994e70d382 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 -`experimental `: Returns, adds, edits, and removes private endpoint services. +`experimental `_: Returns, adds, edits, and removes private endpoint services. Options ------- @@ -49,15 +49,15 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-privateEndpointServices-createPrivateEndpoint` - `experimental `: Creates one private endpoint for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-createPrivateEndpointService` - `experimental `: Creates one private endpoint service for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpoint` - `experimental `: 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` - `experimental `: Removes one private endpoint service from the specified project. -* :ref:`atlas-api-privateEndpointServices-getPrivateEndpoint` - `experimental `: Returns the connection state of the specified private endpoint. -* :ref:`atlas-api-privateEndpointServices-getPrivateEndpointService` - `experimental `: Returns the name, interfaces, and state of the specified private endpoint service from one project. -* :ref:`atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting` - `experimental `: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. -* :ref:`atlas-api-privateEndpointServices-listPrivateEndpointServices` - `experimental `: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. -* :ref:`atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting` - `experimental `: 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` - `experimental `_: Creates one private endpoint for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-createPrivateEndpointService` - `experimental `_: Creates one private endpoint service for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-deletePrivateEndpoint` - `experimental `_: 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` - `experimental `_: Removes one private endpoint service from the specified project. +* :ref:`atlas-api-privateEndpointServices-getPrivateEndpoint` - `experimental `_: Returns the connection state of the specified private endpoint. +* :ref:`atlas-api-privateEndpointServices-getPrivateEndpointService` - `experimental `_: Returns the name, interfaces, and state of the specified private endpoint service from one project. +* :ref:`atlas-api-privateEndpointServices-getRegionalizedPrivateEndpointSetting` - `experimental `_: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. +* :ref:`atlas-api-privateEndpointServices-listPrivateEndpointServices` - `experimental `_: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. +* :ref:`atlas-api-privateEndpointServices-toggleRegionalizedPrivateEndpointSetting` - `experimental `_: 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 29e8e00bbe..dd29a3306e 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 -`experimental `: Assigns the specified organization API key to the specified project. +`experimental `_: Assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'addProjectApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addProjectApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKey.txt index 6015b9a454..25d1c547c5 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 -`experimental `: Creates one API key for the specified organization. +`experimental `_: Creates one API key for the specified organization. An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'createApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-createApiKeyAccessList.txt index 76a96c9ef4..5a9ee26213 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 -`experimental `: Creates the access list entries for the specified organization API key. +`experimental `_: Creates the access list entries for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role. This command is invoking the endpoint with OperationID: 'createApiKeyAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKeyAccessList diff --git a/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-createProjectApiKey.txt index 142acba04d..c5367f0d43 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 -`experimental `: Creates and assigns the specified organization API key to the specified project. +`experimental `_: Creates and assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createProjectApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKey.txt index 8c5e8d2fe8..753aabd41a 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 -`experimental `: Removes one organization API key from the specified organization. +`experimental `_: Removes one organization API key from the specified organization. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'deleteApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt b/docs/command/atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry.txt index 984dc55dd1..fd0de90675 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 -`experimental `: Removes the specified access list entry from the specified organization API key. +`experimental `_: Removes the specified access list entry from the specified organization API key. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. This command is invoking the endpoint with OperationID: 'deleteApiKeyAccessListEntry'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKeyAccessListEntry diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKey.txt index 4412f4535d..7cdf7931ac 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 -`experimental `: Returns one organization API key. +`experimental `_: Returns one organization API key. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'getApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt b/docs/command/atlas-api-programmaticApiKeys-getApiKeyAccessList.txt index 07fc107543..9c544e21b3 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 -`experimental `: Returns one access list entry for the specified organization API key. +`experimental `_: Returns one access list entry for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'getApiKeyAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKeyAccessList diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries.txt index a18b417a58..ca830d62da 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 -`experimental `: Returns all access list entries that you configured for the specified organization API key. +`experimental `_: Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listApiKeyAccessListsEntries'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeyAccessListsEntries diff --git a/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listApiKeys.txt index b1ee3a9a00..5ffa1658ba 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 -`experimental `: Returns all organization API keys for the specified organization. +`experimental `_: Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listApiKeys'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeys diff --git a/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys-listProjectApiKeys.txt index e26006afb4..e2d3422c6d 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 -`experimental `: Returns all organization API keys that you assigned to the specified project. +`experimental `_: Returns all organization API keys that you assigned to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'listProjectApiKeys'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listProjectApiKeys diff --git a/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-removeProjectApiKey.txt index a9c2520cb8..6337270755 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 -`experimental `: Removes one organization API key from the specified project. +`experimental `_: Removes one organization API key from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'removeProjectApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/removeProjectApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKey.txt index 93f337be8d..8617d21c46 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 -`experimental `: Updates one organization API key in the specified organization. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'updateApiKey'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKey diff --git a/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt b/docs/command/atlas-api-programmaticApiKeys-updateApiKeyRoles.txt index 21c27ec759..c219e84e51 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 -`experimental `: Updates the roles of the organization API key that you specify for the project that you specify. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'updateApiKeyRoles'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKeyRoles diff --git a/docs/command/atlas-api-programmaticApiKeys.txt b/docs/command/atlas-api-programmaticApiKeys.txt index 2710711ee1..7f219c0139 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 -`experimental `: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. +`experimental `_: 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 +51,20 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-programmaticApiKeys-addProjectApiKey` - `experimental `: Assigns the specified organization API key to the specified project. -* :ref:`atlas-api-programmaticApiKeys-createApiKey` - `experimental `: Creates one API key for the specified organization. -* :ref:`atlas-api-programmaticApiKeys-createApiKeyAccessList` - `experimental `: Creates the access list entries for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-createProjectApiKey` - `experimental `: Creates and assigns the specified organization API key to the specified project. -* :ref:`atlas-api-programmaticApiKeys-deleteApiKey` - `experimental `: Removes one organization API key from the specified organization. -* :ref:`atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry` - `experimental `: Removes the specified access list entry from the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-getApiKey` - `experimental `: Returns one organization API key. -* :ref:`atlas-api-programmaticApiKeys-getApiKeyAccessList` - `experimental `: Returns one access list entry for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries` - `experimental `: Returns all access list entries that you configured for the specified organization API key. -* :ref:`atlas-api-programmaticApiKeys-listApiKeys` - `experimental `: Returns all organization API keys for the specified organization. -* :ref:`atlas-api-programmaticApiKeys-listProjectApiKeys` - `experimental `: Returns all organization API keys that you assigned to the specified project. -* :ref:`atlas-api-programmaticApiKeys-removeProjectApiKey` - `experimental `: Removes one organization API key from the specified project. -* :ref:`atlas-api-programmaticApiKeys-updateApiKey` - `experimental `: Updates one organization API key in the specified organization. -* :ref:`atlas-api-programmaticApiKeys-updateApiKeyRoles` - `experimental `: Updates the roles of the organization API key that you specify for the project that you specify. +* :ref:`atlas-api-programmaticApiKeys-addProjectApiKey` - `experimental `_: Assigns the specified organization API key to the specified project. +* :ref:`atlas-api-programmaticApiKeys-createApiKey` - `experimental `_: Creates one API key for the specified organization. +* :ref:`atlas-api-programmaticApiKeys-createApiKeyAccessList` - `experimental `_: Creates the access list entries for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-createProjectApiKey` - `experimental `_: Creates and assigns the specified organization API key to the specified project. +* :ref:`atlas-api-programmaticApiKeys-deleteApiKey` - `experimental `_: Removes one organization API key from the specified organization. +* :ref:`atlas-api-programmaticApiKeys-deleteApiKeyAccessListEntry` - `experimental `_: Removes the specified access list entry from the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-getApiKey` - `experimental `_: Returns one organization API key. +* :ref:`atlas-api-programmaticApiKeys-getApiKeyAccessList` - `experimental `_: Returns one access list entry for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-listApiKeyAccessListsEntries` - `experimental `_: Returns all access list entries that you configured for the specified organization API key. +* :ref:`atlas-api-programmaticApiKeys-listApiKeys` - `experimental `_: Returns all organization API keys for the specified organization. +* :ref:`atlas-api-programmaticApiKeys-listProjectApiKeys` - `experimental `_: Returns all organization API keys that you assigned to the specified project. +* :ref:`atlas-api-programmaticApiKeys-removeProjectApiKey` - `experimental `_: Removes one organization API key from the specified project. +* :ref:`atlas-api-programmaticApiKeys-updateApiKey` - `experimental `_: Updates one organization API key in the specified organization. +* :ref:`atlas-api-programmaticApiKeys-updateApiKeyRoles` - `experimental `_: 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 e8a358f06a..54454c520e 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 -`experimental `: Adds one or more access list entries to the specified project. +`experimental `_: Adds one or more access list entries to the specified project. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent POST requests. You must submit multiple POST requests synchronously. This command is invoking the endpoint with OperationID: 'createProjectIpAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/createProjectIpAccessList diff --git a/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList-deleteProjectIpAccessList.txt index e79bd0b1a5..36cf8f165e 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 -`experimental `: Removes one access list entry from the specified project's IP access list. +`experimental `_: Removes one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This command is invoking the endpoint with OperationID: 'deleteProjectIpAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/deleteProjectIpAccessList diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpAccessListStatus.txt index 8dffd9deec..6ca8b51b3b 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 -`experimental `: Returns the status of one project IP access list entry. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'getProjectIpAccessListStatus'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpAccessListStatus diff --git a/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt b/docs/command/atlas-api-projectIpAccessList-getProjectIpList.txt index eca2d43822..856a9ea5c1 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 -`experimental `: Returns one access list entry from the specified project's IP access list. +`experimental `_: Returns one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. This endpoint (/groups/{GROUP-ID}/accessList) manages the Project IP Access List. It doesn't manage the access list for MongoDB Cloud organizations. TheProgrammatic API Keys endpoint (/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist) manages those access lists. This command is invoking the endpoint with OperationID: 'getProjectIpList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpList diff --git a/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt b/docs/command/atlas-api-projectIpAccessList-listProjectIpAccessLists.txt index a72c8cdc9d..8fd470f2df 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 -`experimental `: Returns all access list entries from the specified project's IP access list. +`experimental `_: Returns all access list entries from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The /groups/{GROUP-ID}/accessList endpoint manages the database IP access list. This endpoint is distinct from the orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist endpoint, which manages the access list for MongoDB Cloud organizations. This command is invoking the endpoint with OperationID: 'listProjectIpAccessLists'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/listProjectIpAccessLists diff --git a/docs/command/atlas-api-projectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList.txt index 5fd6e3981f..6834182e67 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 -`experimental `: Returns, adds, edits, and removes network access limits to database deployments in Atlas. +`experimental `_: 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 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projectIpAccessList-createProjectIpAccessList` - `experimental `: Adds one or more access list entries to the specified project. -* :ref:`atlas-api-projectIpAccessList-deleteProjectIpAccessList` - `experimental `: Removes one access list entry from the specified project's IP access list. -* :ref:`atlas-api-projectIpAccessList-getProjectIpAccessListStatus` - `experimental `: Returns the status of one project IP access list entry. -* :ref:`atlas-api-projectIpAccessList-getProjectIpList` - `experimental `: Returns one access list entry from the specified project's IP access list. -* :ref:`atlas-api-projectIpAccessList-listProjectIpAccessLists` - `experimental `: Returns all access list entries from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-createProjectIpAccessList` - `experimental `_: Adds one or more access list entries to the specified project. +* :ref:`atlas-api-projectIpAccessList-deleteProjectIpAccessList` - `experimental `_: Removes one access list entry from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-getProjectIpAccessListStatus` - `experimental `_: Returns the status of one project IP access list entry. +* :ref:`atlas-api-projectIpAccessList-getProjectIpList` - `experimental `_: Returns one access list entry from the specified project's IP access list. +* :ref:`atlas-api-projectIpAccessList-listProjectIpAccessLists` - `experimental `_: 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 ffd4e9d72a..e201951feb 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 -`experimental `: Adds one MongoDB Cloud user to the specified project. +`experimental `_: Adds one MongoDB Cloud user to the specified project. If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting API Key must have the Group User Admin role. This command is invoking the endpoint with OperationID: 'addUserToProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/addUserToProject diff --git a/docs/command/atlas-api-projects-createProject.txt b/docs/command/atlas-api-projects-createProject.txt index e845688a6d..ca04a11935 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 -`experimental `: Creates one project. +`experimental `_: Creates one project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Read Write role. This command is invoking the endpoint with OperationID: 'createProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProject diff --git a/docs/command/atlas-api-projects-createProjectInvitation.txt b/docs/command/atlas-api-projects-createProjectInvitation.txt index 442294ac73..8a0fa8a693 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 -`experimental `: Invites one MongoDB Cloud user to join the specified project. +`experimental `_: Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createProjectInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation diff --git a/docs/command/atlas-api-projects-deleteProject.txt b/docs/command/atlas-api-projects-deleteProject.txt index 085bf8ea7f..00774834ce 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 -`experimental `: Removes the specified project. +`experimental `_: Removes the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProject diff --git a/docs/command/atlas-api-projects-deleteProjectInvitation.txt b/docs/command/atlas-api-projects-deleteProjectInvitation.txt index d30807614e..5e985f5de9 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 -`experimental `: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. +`experimental `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteProjectInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectInvitation diff --git a/docs/command/atlas-api-projects-deleteProjectLimit.txt b/docs/command/atlas-api-projects-deleteProjectLimit.txt index 5d39d8c960..ba9f3bcf24 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 -`experimental `: Removes the specified project limit. +`experimental `_: Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteProjectLimit'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectLimit diff --git a/docs/command/atlas-api-projects-getProject.txt b/docs/command/atlas-api-projects-getProject.txt index cda96f88fd..c647871725 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 -`experimental `: Returns details about the specified project. +`experimental `_: Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProject diff --git a/docs/command/atlas-api-projects-getProjectByName.txt b/docs/command/atlas-api-projects-getProjectByName.txt index 8f9a5dca81..662b14cd2e 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 -`experimental `: Returns details about the specified project. +`experimental `_: Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getProjectByName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectByName diff --git a/docs/command/atlas-api-projects-getProjectInvitation.txt b/docs/command/atlas-api-projects-getProjectInvitation.txt index 1212c7331d..45b685af8f 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 -`experimental `: Returns the details of one pending invitation to the specified project. +`experimental `_: Returns the details of one pending invitation to the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'getProjectInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectInvitation diff --git a/docs/command/atlas-api-projects-getProjectLimit.txt b/docs/command/atlas-api-projects-getProjectLimit.txt index e4b8bd351a..6868d883a2 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 -`experimental `: Returns the specified limit for the specified project. +`experimental `_: Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getProjectLimit'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLimit diff --git a/docs/command/atlas-api-projects-getProjectLtsVersions.txt b/docs/command/atlas-api-projects-getProjectLtsVersions.txt index 0c26117ea1..7f61408425 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 -`experimental `: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. +`experimental `_: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. This command is invoking the endpoint with OperationID: 'getProjectLtsVersions'. For more information about flags, format of --file and examples, see: 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 99faefa49c..464b2bfc73 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 -`experimental `: Returns details about the specified project's settings. +`experimental `_: Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getProjectSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectSettings diff --git a/docs/command/atlas-api-projects-listProjectInvitations.txt b/docs/command/atlas-api-projects-listProjectInvitations.txt index 7656edb24a..85ea4d5364 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 -`experimental `: Returns all pending invitations to the specified project. +`experimental `_: Returns all pending invitations to the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'listProjectInvitations'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectInvitations diff --git a/docs/command/atlas-api-projects-listProjectLimits.txt b/docs/command/atlas-api-projects-listProjectLimits.txt index fc47ede3b9..ef55b12697 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 -`experimental `: Returns all the limits for the specified project. +`experimental `_: Returns all the limits for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listProjectLimits'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectLimits diff --git a/docs/command/atlas-api-projects-listProjectUsers.txt b/docs/command/atlas-api-projects-listProjectUsers.txt index 751b879567..59e81cd208 100644 --- a/docs/command/atlas-api-projects-listProjectUsers.txt +++ b/docs/command/atlas-api-projects-listProjectUsers.txt @@ -12,7 +12,7 @@ atlas api projects listProjectUsers :depth: 1 :class: singlecol -`experimental `: Returns details about all users in the specified project. +`experimental `_: Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listProjectUsers'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectUsers diff --git a/docs/command/atlas-api-projects-listProjects.txt b/docs/command/atlas-api-projects-listProjects.txt index d774e52738..fa4c5d9533 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 -`experimental `: Returns details about all projects. +`experimental `_: Returns details about all projects. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting API Key must have the Organization Read Only role or higher. This command is invoking the endpoint with OperationID: 'listProjects'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjects diff --git a/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt b/docs/command/atlas-api-projects-migrateProjectToAnotherOrg.txt index aae8b9d1fc..90c2902b5a 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 -`experimental `: Migrates a project from its current organization to another organization. +`experimental `_: Migrates a project from its current organization to another organization. All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'migrateProjectToAnotherOrg'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/migrateProjectToAnotherOrg diff --git a/docs/command/atlas-api-projects-removeProjectUser.txt b/docs/command/atlas-api-projects-removeProjectUser.txt index 9e5b11b5dd..1324bb4ab5 100644 --- a/docs/command/atlas-api-projects-removeProjectUser.txt +++ b/docs/command/atlas-api-projects-removeProjectUser.txt @@ -12,7 +12,7 @@ atlas api projects removeProjectUser :depth: 1 :class: singlecol -`experimental `: Removes the specified user from the specified project. +`experimental `_: Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'removeProjectUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/removeProjectUser diff --git a/docs/command/atlas-api-projects-returnAllIpAddresses.txt b/docs/command/atlas-api-projects-returnAllIpAddresses.txt index af715647be..9bd1863572 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 -`experimental `: Returns all IP addresses for this project. +`experimental `_: Returns all IP addresses for this project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'returnAllIpAddresses'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/returnAllIpAddresses diff --git a/docs/command/atlas-api-projects-setProjectLimit.txt b/docs/command/atlas-api-projects-setProjectLimit.txt index ab5635feef..f417cce879 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 -`experimental `: Sets the specified project limit. +`experimental `_: Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role. NOTE: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern. This command is invoking the endpoint with OperationID: 'setProjectLimit'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/setProjectLimit diff --git a/docs/command/atlas-api-projects-updateProject.txt b/docs/command/atlas-api-projects-updateProject.txt index 427e0c331e..c31fdcebbe 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 -`experimental `: Updates the human-readable label that identifies the specified project, or the tags associated with the project. +`experimental `_: Updates the human-readable label that identifies the specified project, or the tags associated with the project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProject diff --git a/docs/command/atlas-api-projects-updateProjectInvitation.txt b/docs/command/atlas-api-projects-updateProjectInvitation.txt index 7f2652b665..9d76ed990d 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 -`experimental `: Updates the details of one pending invitation to the specified project. +`experimental `_: Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateProjectInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitation diff --git a/docs/command/atlas-api-projects-updateProjectInvitationById.txt b/docs/command/atlas-api-projects-updateProjectInvitationById.txt index c82d251dcc..5351127e3e 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 -`experimental `: Updates the details of one pending invitation to the specified project. +`experimental `_: Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateProjectInvitationById'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitationById diff --git a/docs/command/atlas-api-projects-updateProjectRoles.txt b/docs/command/atlas-api-projects-updateProjectRoles.txt index ed2b69f961..6a7124053a 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 -`experimental `: Updates the roles of the specified user in the specified project. +`experimental `_: Updates the roles of the specified user in the specified project. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting API Key must have the Group User Admin role. This command is invoking the endpoint with OperationID: 'updateProjectRoles'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectRoles diff --git a/docs/command/atlas-api-projects-updateProjectSettings.txt b/docs/command/atlas-api-projects-updateProjectSettings.txt index 78bd546178..e4263256be 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 -`experimental `: Updates the settings of the specified project. +`experimental `_: Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateProjectSettings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectSettings diff --git a/docs/command/atlas-api-projects.txt b/docs/command/atlas-api-projects.txt index 264950be38..5f5ebb750f 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 -`experimental `: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. +`experimental `_: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. Options ------- @@ -49,31 +49,31 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-projects-addUserToProject` - `experimental `: Adds one MongoDB Cloud user to the specified project. -* :ref:`atlas-api-projects-createProject` - `experimental `: Creates one project. -* :ref:`atlas-api-projects-createProjectInvitation` - `experimental `: Invites one MongoDB Cloud user to join the specified project. -* :ref:`atlas-api-projects-deleteProject` - `experimental `: Removes the specified project. -* :ref:`atlas-api-projects-deleteProjectInvitation` - `experimental `: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. -* :ref:`atlas-api-projects-deleteProjectLimit` - `experimental `: Removes the specified project limit. -* :ref:`atlas-api-projects-getProject` - `experimental `: Returns details about the specified project. -* :ref:`atlas-api-projects-getProjectByName` - `experimental `: Returns details about the specified project. -* :ref:`atlas-api-projects-getProjectInvitation` - `experimental `: Returns the details of one pending invitation to the specified project. -* :ref:`atlas-api-projects-getProjectLimit` - `experimental `: Returns the specified limit for the specified project. -* :ref:`atlas-api-projects-getProjectLtsVersions` - `experimental `: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. -* :ref:`atlas-api-projects-getProjectSettings` - `experimental `: Returns details about the specified project's settings. -* :ref:`atlas-api-projects-listProjectInvitations` - `experimental `: Returns all pending invitations to the specified project. -* :ref:`atlas-api-projects-listProjectLimits` - `experimental `: Returns all the limits for the specified project. -* :ref:`atlas-api-projects-listProjectUsers` - `experimental `: Returns details about all users in the specified project. -* :ref:`atlas-api-projects-listProjects` - `experimental `: Returns details about all projects. -* :ref:`atlas-api-projects-migrateProjectToAnotherOrg` - `experimental `: Migrates a project from its current organization to another organization. -* :ref:`atlas-api-projects-removeProjectUser` - `experimental `: Removes the specified user from the specified project. -* :ref:`atlas-api-projects-returnAllIpAddresses` - `experimental `: Returns all IP addresses for this project. -* :ref:`atlas-api-projects-setProjectLimit` - `experimental `: Sets the specified project limit. -* :ref:`atlas-api-projects-updateProject` - `experimental `: Updates the human-readable label that identifies the specified project, or the tags associated with the project. -* :ref:`atlas-api-projects-updateProjectInvitation` - `experimental `: Updates the details of one pending invitation to the specified project. -* :ref:`atlas-api-projects-updateProjectInvitationById` - `experimental `: Updates the details of one pending invitation to the specified project. -* :ref:`atlas-api-projects-updateProjectRoles` - `experimental `: Updates the roles of the specified user in the specified project. -* :ref:`atlas-api-projects-updateProjectSettings` - `experimental `: Updates the settings of the specified project. +* :ref:`atlas-api-projects-addUserToProject` - `experimental `_: Adds one MongoDB Cloud user to the specified project. +* :ref:`atlas-api-projects-createProject` - `experimental `_: Creates one project. +* :ref:`atlas-api-projects-createProjectInvitation` - `experimental `_: Invites one MongoDB Cloud user to join the specified project. +* :ref:`atlas-api-projects-deleteProject` - `experimental `_: Removes the specified project. +* :ref:`atlas-api-projects-deleteProjectInvitation` - `experimental `_: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. +* :ref:`atlas-api-projects-deleteProjectLimit` - `experimental `_: Removes the specified project limit. +* :ref:`atlas-api-projects-getProject` - `experimental `_: Returns details about the specified project. +* :ref:`atlas-api-projects-getProjectByName` - `experimental `_: Returns details about the specified project. +* :ref:`atlas-api-projects-getProjectInvitation` - `experimental `_: Returns the details of one pending invitation to the specified project. +* :ref:`atlas-api-projects-getProjectLimit` - `experimental `_: Returns the specified limit for the specified project. +* :ref:`atlas-api-projects-getProjectLtsVersions` - `experimental `_: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. +* :ref:`atlas-api-projects-getProjectSettings` - `experimental `_: Returns details about the specified project's settings. +* :ref:`atlas-api-projects-listProjectInvitations` - `experimental `_: Returns all pending invitations to the specified project. +* :ref:`atlas-api-projects-listProjectLimits` - `experimental `_: Returns all the limits for the specified project. +* :ref:`atlas-api-projects-listProjectUsers` - `experimental `_: Returns details about all users in the specified project. +* :ref:`atlas-api-projects-listProjects` - `experimental `_: Returns details about all projects. +* :ref:`atlas-api-projects-migrateProjectToAnotherOrg` - `experimental `_: Migrates a project from its current organization to another organization. +* :ref:`atlas-api-projects-removeProjectUser` - `experimental `_: Removes the specified user from the specified project. +* :ref:`atlas-api-projects-returnAllIpAddresses` - `experimental `_: Returns all IP addresses for this project. +* :ref:`atlas-api-projects-setProjectLimit` - `experimental `_: Sets the specified project limit. +* :ref:`atlas-api-projects-updateProject` - `experimental `_: Updates the human-readable label that identifies the specified project, or the tags associated with the project. +* :ref:`atlas-api-projects-updateProjectInvitation` - `experimental `_: Updates the details of one pending invitation to the specified project. +* :ref:`atlas-api-projects-updateProjectInvitationById` - `experimental `_: Updates the details of one pending invitation to the specified project. +* :ref:`atlas-api-projects-updateProjectRoles` - `experimental `_: Updates the roles of the specified user in the specified project. +* :ref:`atlas-api-projects-updateProjectSettings` - `experimental `_: 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 acf0b675f4..7d8720ddad 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 -`experimental `: Configures the project level settings for the push-based log export feature. +`experimental `_: Configures the project level settings for the push-based log export feature. This command is invoking the endpoint with OperationID: 'createPushBasedLogConfiguration'. For more information about flags, format of --file and examples, see: 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 5ec7ba9fba..fbffa02e52 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 -`experimental `: Disables the push-based log export feature by resetting the project level settings to its default configuration. +`experimental `_: Disables the push-based log export feature by resetting the project level settings to its default configuration. This command is invoking the endpoint with OperationID: 'deletePushBasedLogConfiguration'. For more information about flags, format of --file and examples, see: 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 190dfc9f67..d4081f2c13 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 -`experimental `: Fetches the current project level settings for the push-based log export feature. +`experimental `_: Fetches the current project level settings for the push-based log export feature. This command is invoking the endpoint with OperationID: 'getPushBasedLogConfiguration'. For more information about flags, format of --file and examples, see: 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 570f2427df..a83b3a1293 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 -`experimental `: Updates the project level settings for the push-based log export feature. +`experimental `_: Updates the project level settings for the push-based log export feature. This command is invoking the endpoint with OperationID: 'updatePushBasedLogConfiguration'. For more information about flags, format of --file and examples, see: 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 d4d6636a33..e4be0e2d16 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 -`experimental `: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. +`experimental `_: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes. @@ -51,10 +51,10 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-pushBasedLogExport-createPushBasedLogConfiguration` - `experimental `: Configures the project level settings for the push-based log export feature. -* :ref:`atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration` - `experimental `: Disables the push-based log export feature by resetting the project level settings to its default configuration. -* :ref:`atlas-api-pushBasedLogExport-getPushBasedLogConfiguration` - `experimental `: Fetches the current project level settings for the push-based log export feature. -* :ref:`atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration` - `experimental `: Updates the project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-createPushBasedLogConfiguration` - `experimental `_: Configures the project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-deletePushBasedLogConfiguration` - `experimental `_: Disables the push-based log export feature by resetting the project level settings to its default configuration. +* :ref:`atlas-api-pushBasedLogExport-getPushBasedLogConfiguration` - `experimental `_: Fetches the current project level settings for the push-based log export feature. +* :ref:`atlas-api-pushBasedLogExport-updatePushBasedLogConfiguration` - `experimental `_: 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 74923a4e1f..f88c814353 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 -`experimental `: Create one Atlas Resource Policy for an org. +`experimental `_: Create one Atlas Resource Policy for an org. This command is invoking the endpoint with OperationID: 'createAtlasResourcePolicy'. For more information about flags, format of --file and examples, see: 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 0ceef61d9d..56c510f6ba 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 -`experimental `: Delete one Atlas Resource Policy for an org. +`experimental `_: Delete one Atlas Resource Policy for an org. This command is invoking the endpoint with OperationID: 'deleteAtlasResourcePolicy'. For more information about flags, format of --file and examples, see: 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 dc79ddce14..86b8067e43 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 -`experimental `: Return all Atlas Resource Policies for the org. +`experimental `_: Return all Atlas Resource Policies for the org. This command is invoking the endpoint with OperationID: 'getAtlasResourcePolicies'. For more information about flags, format of --file and examples, see: 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 04d1e53a05..dd3731a855 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 -`experimental `: Return one Atlas Resource Policy for an org. +`experimental `_: Return one Atlas Resource Policy for an org. This command is invoking the endpoint with OperationID: 'getAtlasResourcePolicy'. For more information about flags, format of --file and examples, see: 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 6b0cbc7cc0..a5a46bd4f9 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 -`experimental `: Return all non-compliant resources for an org. +`experimental `_: Return all non-compliant resources for an org. This command is invoking the endpoint with OperationID: 'getResourcesNonCompliant'. For more information about flags, format of --file and examples, see: 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 307de5721b..9314c01615 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 -`experimental `: Update one Atlas Resource Policy for an org. +`experimental `_: Update one Atlas Resource Policy for an org. This command is invoking the endpoint with OperationID: 'updateAtlasResourcePolicy'. For more information about flags, format of --file and examples, see: 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 f05bb0aa8d..236d20fe96 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 -`experimental `: Validate one Atlas Resource Policy for an org. +`experimental `_: Validate one Atlas Resource Policy for an org. This command is invoking the endpoint with OperationID: 'validateAtlasResourcePolicy'. For more information about flags, format of --file and examples, see: 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 facb88af23..beb41d85c4 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 -`experimental `: Configure and manage Atlas Resource Policies within your organization. +`experimental `_: Configure and manage Atlas Resource Policies within your organization. Options ------- @@ -49,13 +49,13 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-resourcePolicies-createAtlasResourcePolicy` - `experimental `: Create one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-deleteAtlasResourcePolicy` - `experimental `: Delete one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicies` - `experimental `: Return all Atlas Resource Policies for the org. -* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicy` - `experimental `: Return one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-getResourcesNonCompliant` - `experimental `: Return all non-compliant resources for an org. -* :ref:`atlas-api-resourcePolicies-updateAtlasResourcePolicy` - `experimental `: Update one Atlas Resource Policy for an org. -* :ref:`atlas-api-resourcePolicies-validateAtlasResourcePolicy` - `experimental `: Validate one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-createAtlasResourcePolicy` - `experimental `_: Create one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-deleteAtlasResourcePolicy` - `experimental `_: Delete one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicies` - `experimental `_: Return all Atlas Resource Policies for the org. +* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicy` - `experimental `_: Return one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-getResourcesNonCompliant` - `experimental `_: Return all non-compliant resources for an org. +* :ref:`atlas-api-resourcePolicies-updateAtlasResourcePolicy` - `experimental `_: Update one Atlas Resource Policy for an org. +* :ref:`atlas-api-resourcePolicies-validateAtlasResourcePolicy` - `experimental `_: 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 5698cbc45d..f79dad6da7 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 -`experimental `: Creates an index on the cluster identified by its name in a rolling manner. +`experimental `_: Creates an index on the cluster identified by its name in a rolling manner. Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'createRollingIndex'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Rolling-Index/operation/createRollingIndex diff --git a/docs/command/atlas-api-rollingIndex.txt b/docs/command/atlas-api-rollingIndex.txt index aecde57d09..c6b73a0266 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 -`experimental `: Creates one index to a database deployment in a rolling manner. +`experimental `_: 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 +51,7 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-rollingIndex-createRollingIndex` - `experimental `: Creates an index on the cluster identified by its name in a rolling manner. +* :ref:`atlas-api-rollingIndex-createRollingIndex` - `experimental `_: 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 9d997c98da..c40b130075 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 -`experimental `: This resource returns information about the MongoDB application along with API key meta data. +`experimental `_: This resource returns information about the MongoDB application along with API key meta data. This command is invoking the endpoint with OperationID: 'getSystemStatus'. For more information about flags, format of --file and examples, see: 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 baad337e06..d40858f6c3 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 -`experimental `: Returns all control plane IP addresses. +`experimental `_: Returns all control plane IP addresses. This command is invoking the endpoint with OperationID: 'returnAllControlPlaneIpAddresses'. For more information about flags, format of --file and examples, see: 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 be5b83d4cd..0d92172e50 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 -`experimental `: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. +`experimental `_: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API. @@ -51,8 +51,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-root-getSystemStatus` - `experimental `: This resource returns information about the MongoDB application along with API key meta data. -* :ref:`atlas-api-root-returnAllControlPlaneIpAddresses` - `experimental `: Returns all control plane IP addresses. +* :ref:`atlas-api-root-getSystemStatus` - `experimental `_: This resource returns information about the MongoDB application along with API key meta data. +* :ref:`atlas-api-root-returnAllControlPlaneIpAddresses` - `experimental `_: 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 2f9c2616aa..d940e6c632 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 -`experimental `: Creates one serverless instance in the specified project. +`experimental `_: Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createServerlessInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance diff --git a/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-deleteServerlessInstance.txt index b15d433214..24c8211de3 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 -`experimental `: Removes one serverless instance from the specified project. +`experimental `_: Removes one serverless instance from the specified project. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteServerlessInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/deleteServerlessInstance diff --git a/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-getServerlessInstance.txt index 5f3e546c1d..3d01e3aa50 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 -`experimental `: Returns details for one serverless instance in the specified project. +`experimental `_: Returns details for one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getServerlessInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/getServerlessInstance diff --git a/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt b/docs/command/atlas-api-serverlessInstances-listServerlessInstances.txt index aa9c080c9c..e8d9bfa9f8 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 -`experimental `: Returns details for all serverless instances in the specified project. +`experimental `_: Returns details for all serverless instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listServerlessInstances'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/listServerlessInstances diff --git a/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt b/docs/command/atlas-api-serverlessInstances-updateServerlessInstance.txt index 9a85fe6363..3a800714c2 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 -`experimental `: Updates one serverless instance in the specified project. +`experimental `_: Updates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateServerlessInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/updateServerlessInstance diff --git a/docs/command/atlas-api-serverlessInstances.txt b/docs/command/atlas-api-serverlessInstances.txt index 2a91e7f74c..4253dbc8d2 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 -`experimental `: Returns, adds, edits, and removes serverless instances. +`experimental `_: Returns, adds, edits, and removes serverless instances. Options ------- @@ -49,11 +49,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serverlessInstances-createServerlessInstance` - `experimental `: Creates one serverless instance in the specified project. -* :ref:`atlas-api-serverlessInstances-deleteServerlessInstance` - `experimental `: Removes one serverless instance from the specified project. -* :ref:`atlas-api-serverlessInstances-getServerlessInstance` - `experimental `: Returns details for one serverless instance in the specified project. -* :ref:`atlas-api-serverlessInstances-listServerlessInstances` - `experimental `: Returns details for all serverless instances in the specified project. -* :ref:`atlas-api-serverlessInstances-updateServerlessInstance` - `experimental `: Updates one serverless instance in the specified project. +* :ref:`atlas-api-serverlessInstances-createServerlessInstance` - `experimental `_: Creates one serverless instance in the specified project. +* :ref:`atlas-api-serverlessInstances-deleteServerlessInstance` - `experimental `_: Removes one serverless instance from the specified project. +* :ref:`atlas-api-serverlessInstances-getServerlessInstance` - `experimental `_: Returns details for one serverless instance in the specified project. +* :ref:`atlas-api-serverlessInstances-listServerlessInstances` - `experimental `_: Returns details for all serverless instances in the specified project. +* :ref:`atlas-api-serverlessInstances-updateServerlessInstance` - `experimental `_: 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 95722737e9..b8d36ff0e8 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 -`experimental `: Creates one private endpoint for one serverless instance. +`experimental `_: Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance. This command is invoking the endpoint with OperationID: 'createServerlessPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/createServerlessPrivateEndpoint diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint.txt index eb5b0ef6be..a2e8c227e1 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 -`experimental `: Remove one private endpoint from one serverless instance. +`experimental `_: Remove one private endpoint from one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteServerlessPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/deleteServerlessPrivateEndpoint diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint.txt index e05c2a9e71..48a2aabd15 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 -`experimental `: Return one private endpoint for one serverless instance. +`experimental `_: Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. This command is invoking the endpoint with OperationID: 'getServerlessPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/getServerlessPrivateEndpoint diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints.txt index b220c5890d..90705b13a9 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 -`experimental `: Returns all private endpoints for one serverless instance. +`experimental `_: Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource. This command is invoking the endpoint with OperationID: 'listServerlessPrivateEndpoints'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/listServerlessPrivateEndpoints diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt b/docs/command/atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint.txt index 217e1b3a6b..b162a2ae67 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 -`experimental `: Updates one private endpoint for one serverless instance. +`experimental `_: Updates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateServerlessPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/updateServerlessPrivateEndpoint diff --git a/docs/command/atlas-api-serverlessPrivateEndpoints.txt b/docs/command/atlas-api-serverlessPrivateEndpoints.txt index 57d4a01683..95b6b09cae 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 -`experimental `: Returns, adds, edits, and removes private endpoints for serverless instances. +`experimental `_: 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 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint` - `experimental `: Creates one private endpoint for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint` - `experimental `: Remove one private endpoint from one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint` - `experimental `: Return one private endpoint for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints` - `experimental `: Returns all private endpoints for one serverless instance. -* :ref:`atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint` - `experimental `: Updates one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-createServerlessPrivateEndpoint` - `experimental `_: Creates one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-deleteServerlessPrivateEndpoint` - `experimental `_: Remove one private endpoint from one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-getServerlessPrivateEndpoint` - `experimental `_: Return one private endpoint for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-listServerlessPrivateEndpoints` - `experimental `_: Returns all private endpoints for one serverless instance. +* :ref:`atlas-api-serverlessPrivateEndpoints-updateServerlessPrivateEndpoint` - `experimental `_: 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 8846bc27e4..def5692b87 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 -`experimental `: Assigns the specified Service Account to the specified Project. +`experimental `_: Assigns the specified Service Account to the specified Project. Available as a preview feature. This command is invoking the endpoint with OperationID: 'addProjectServiceAccount'. For more information about flags, format of --file and examples, see: 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 cec7da0962..0a667d6bbf 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 -`experimental `: Creates one Service Account for the specified Project. +`experimental `_: Creates one Service Account for the specified Project. The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. Available as a preview feature. This command is invoking the endpoint with OperationID: 'createProjectServiceAccount'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccount diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountAccessList.txt index e417d0f838..ea6a0d1afa 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 -`experimental `: Add Access List Entries for the specified Service Account for the project. +`experimental `_: Add Access List Entries for the specified Service Account for the project. Resources require all API requests to originate from IP addresses on the API access list. Available as a preview feature. This command is invoking the endpoint with OperationID: 'createProjectServiceAccountAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountAccessList diff --git a/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createProjectServiceAccountSecret.txt index 0f0b224a83..d0a7c034a1 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 -`experimental `: Create a secret for the specified Service Account in the specified Project. +`experimental `_: Create a secret for the specified Service Account in the specified Project. Available as a preview feature. This command is invoking the endpoint with OperationID: 'createProjectServiceAccountSecret'. For more information about flags, format of --file and examples, see: 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 cbab83fc31..709c2a58eb 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 -`experimental `: Creates one Service Account for the specified Organization. +`experimental `_: Creates one Service Account for the specified Organization. Available as a preview feature. This command is invoking the endpoint with OperationID: 'createServiceAccount'. For more information about flags, format of --file and examples, see: 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 c74a99a735..59eed62eea 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 -`experimental `: Add Access List Entries for the specified Service Account for the organization. +`experimental `_: 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. Available as a preview feature. This command is invoking the endpoint with OperationID: 'createServiceAccountAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountAccessList diff --git a/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-createServiceAccountSecret.txt index b336807572..858f1a3958 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 -`experimental `: Create a secret for the specified Service Account. +`experimental `_: Create a secret for the specified Service Account. Available as a preview feature. This command is invoking the endpoint with OperationID: 'createServiceAccountSecret'. For more information about flags, format of --file and examples, see: 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 242a4609fa..4e72d2cd67 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 -`experimental `: Removes the specified Service Account from the specified project. +`experimental `_: Removes the specified Service Account from the specified project. The Service Account will still be a part of the Organization it was created in, and the credentials will remain active until expired or manually revoked. Available as a preview feature. This command is invoking the endpoint with OperationID: 'deleteProjectServiceAccount'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccount diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry.txt index 8e5466982d..59a4f4592c 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 -`experimental `: Removes the specified access list entry from the specified Service Account for the project. +`experimental `_: Removes the specified access list entry from the specified Service Account for the project. You can't remove the requesting IP address from the access list. Available as a preview feature. This command is invoking the endpoint with OperationID: 'deleteProjectServiceAccountAccessListEntry'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountAccessListEntry diff --git a/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteProjectServiceAccountSecret.txt index e340b70219..9b540454cf 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 -`experimental `: Deletes the specified Service Account secret. +`experimental `_: Deletes the specified Service Account secret. Available as a preview feature. This command is invoking the endpoint with OperationID: 'deleteProjectServiceAccountSecret'. For more information about flags, format of --file and examples, see: 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 20676f74e8..ab20bdee01 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 -`experimental `: Deletes the specified Service Account. +`experimental `_: Deletes the specified Service Account. Available as a preview feature. This command is invoking the endpoint with OperationID: 'deleteServiceAccount'. For more information about flags, format of --file and examples, see: 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 cedcdc0003..41367df498 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 -`experimental `: Removes the specified access list entry from the specified Service Account for the organization. +`experimental `_: 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. Available as a preview feature. This command is invoking the endpoint with OperationID: 'deleteServiceAccountAccessListEntry'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountAccessListEntry diff --git a/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt b/docs/command/atlas-api-serviceAccounts-deleteServiceAccountSecret.txt index 7cf8acfa8b..b669911e95 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 -`experimental `: Deletes the specified Service Account secret. +`experimental `_: Deletes the specified Service Account secret. Available as a preview feature. This command is invoking the endpoint with OperationID: 'deleteServiceAccountSecret'. For more information about flags, format of --file and examples, see: 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 1e09c18650..e10e0f0f66 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 -`experimental `: Returns one Service Account in the specified Project. +`experimental `_: Returns one Service Account in the specified Project. Available as a preview feature. This command is invoking the endpoint with OperationID: 'getProjectServiceAccount'. For more information about flags, format of --file and examples, see: 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 9f19540134..36fecf09a1 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 -`experimental `: Returns the specified Service Account. +`experimental `_: Returns the specified Service Account. Available as a preview feature. This command is invoking the endpoint with OperationID: 'getServiceAccount'. For more information about flags, format of --file and examples, see: 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 5f85854ffa..b0418041fe 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 -`experimental `: Returns all access list entries that you configured for the specified Service Account for the project. +`experimental `_: Returns all access list entries that you configured for the specified Service Account for the project. Available as a preview feature. This command is invoking the endpoint with OperationID: 'listProjectServiceAccountAccessList'. For more information about flags, format of --file and examples, see: 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 fb7bd5250e..2aa3dd698d 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 -`experimental `: Returns all Service Accounts for the specified Project. +`experimental `_: Returns all Service Accounts for the specified Project. Available as a preview feature. This command is invoking the endpoint with OperationID: 'listProjectServiceAccounts'. For more information about flags, format of --file and examples, see: 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 547d388f71..41447d982b 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 -`experimental `: Returns all access list entries that you configured for the specified Service Account for the organization. +`experimental `_: Returns all access list entries that you configured for the specified Service Account for the organization. Available as a preview feature. This command is invoking the endpoint with OperationID: 'listServiceAccountAccessList'. For more information about flags, format of --file and examples, see: 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 8c683f0d0d..0bac233343 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 -`experimental `: Returns a list of all projects the specified Service Account is a part of. +`experimental `_: Returns a list of all projects the specified Service Account is a part of. Available as a preview feature. This command is invoking the endpoint with OperationID: 'listServiceAccountProjects'. For more information about flags, format of --file and examples, see: 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 a8081cd1a1..aa2f62d926 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 -`experimental `: Returns all Service Accounts for the specified Organization. +`experimental `_: Returns all Service Accounts for the specified Organization. Available as a preview feature. This command is invoking the endpoint with OperationID: 'listServiceAccounts'. For more information about flags, format of --file and examples, see: 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 5c8386fba0..1b0eb9a92a 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 -`experimental `: Updates one Service Account in the specified Project. +`experimental `_: Updates one Service Account in the specified Project. Available as a preview feature. This command is invoking the endpoint with OperationID: 'updateProjectServiceAccount'. For more information about flags, format of --file and examples, see: 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 a37a4fd15b..9576356dbf 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 -`experimental `: Updates the specified Service Account in the specified Organization. +`experimental `_: Updates the specified Service Account in the specified Organization. Available as a preview feature. This command is invoking the endpoint with OperationID: 'updateServiceAccount'. For more information about flags, format of --file and examples, see: 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 0e8f43386a..a87356afc4 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 -`experimental `: Endpoints for managing Service Accounts and secrets. +`experimental `_: Endpoints for managing Service Accounts and secrets. Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow. This feature is available as a Preview feature. @@ -51,28 +51,28 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-serviceAccounts-addProjectServiceAccount` - `experimental `: Assigns the specified Service Account to the specified Project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccount` - `experimental `: Creates one Service Account for the specified Project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountAccessList` - `experimental `: Add Access List Entries for the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountSecret` - `experimental `: Create a secret for the specified Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-createServiceAccount` - `experimental `: Creates one Service Account for the specified Organization. -* :ref:`atlas-api-serviceAccounts-createServiceAccountAccessList` - `experimental `: Add Access List Entries for the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-createServiceAccountSecret` - `experimental `: Create a secret for the specified Service Account. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccount` - `experimental `: Removes the specified Service Account from the specified project. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry` - `experimental `: Removes the specified access list entry from the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountSecret` - `experimental `: Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccount` - `experimental `: Deletes the specified Service Account. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry` - `experimental `: Removes the specified access list entry from the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-deleteServiceAccountSecret` - `experimental `: Deletes the specified Service Account secret. -* :ref:`atlas-api-serviceAccounts-getProjectServiceAccount` - `experimental `: Returns one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-getServiceAccount` - `experimental `: Returns the specified Service Account. -* :ref:`atlas-api-serviceAccounts-listProjectServiceAccountAccessList` - `experimental `: Returns all access list entries that you configured for the specified Service Account for the project. -* :ref:`atlas-api-serviceAccounts-listProjectServiceAccounts` - `experimental `: Returns all Service Accounts for the specified Project. -* :ref:`atlas-api-serviceAccounts-listServiceAccountAccessList` - `experimental `: Returns all access list entries that you configured for the specified Service Account for the organization. -* :ref:`atlas-api-serviceAccounts-listServiceAccountProjects` - `experimental `: Returns a list of all projects the specified Service Account is a part of. -* :ref:`atlas-api-serviceAccounts-listServiceAccounts` - `experimental `: Returns all Service Accounts for the specified Organization. -* :ref:`atlas-api-serviceAccounts-updateProjectServiceAccount` - `experimental `: Updates one Service Account in the specified Project. -* :ref:`atlas-api-serviceAccounts-updateServiceAccount` - `experimental `: Updates the specified Service Account in the specified Organization. +* :ref:`atlas-api-serviceAccounts-addProjectServiceAccount` - `experimental `_: Assigns the specified Service Account to the specified Project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccount` - `experimental `_: Creates one Service Account for the specified Project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountAccessList` - `experimental `_: Add Access List Entries for the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-createProjectServiceAccountSecret` - `experimental `_: Create a secret for the specified Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-createServiceAccount` - `experimental `_: Creates one Service Account for the specified Organization. +* :ref:`atlas-api-serviceAccounts-createServiceAccountAccessList` - `experimental `_: Add Access List Entries for the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-createServiceAccountSecret` - `experimental `_: Create a secret for the specified Service Account. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccount` - `experimental `_: Removes the specified Service Account from the specified project. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountAccessListEntry` - `experimental `_: Removes the specified access list entry from the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-deleteProjectServiceAccountSecret` - `experimental `_: Deletes the specified Service Account secret. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccount` - `experimental `_: Deletes the specified Service Account. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccountAccessListEntry` - `experimental `_: Removes the specified access list entry from the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-deleteServiceAccountSecret` - `experimental `_: Deletes the specified Service Account secret. +* :ref:`atlas-api-serviceAccounts-getProjectServiceAccount` - `experimental `_: Returns one Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-getServiceAccount` - `experimental `_: Returns the specified Service Account. +* :ref:`atlas-api-serviceAccounts-listProjectServiceAccountAccessList` - `experimental `_: Returns all access list entries that you configured for the specified Service Account for the project. +* :ref:`atlas-api-serviceAccounts-listProjectServiceAccounts` - `experimental `_: Returns all Service Accounts for the specified Project. +* :ref:`atlas-api-serviceAccounts-listServiceAccountAccessList` - `experimental `_: Returns all access list entries that you configured for the specified Service Account for the organization. +* :ref:`atlas-api-serviceAccounts-listServiceAccountProjects` - `experimental `_: Returns a list of all projects the specified Service Account is a part of. +* :ref:`atlas-api-serviceAccounts-listServiceAccounts` - `experimental `_: Returns all Service Accounts for the specified Organization. +* :ref:`atlas-api-serviceAccounts-updateProjectServiceAccount` - `experimental `_: Updates one Service Account in the specified Project. +* :ref:`atlas-api-serviceAccounts-updateServiceAccount` - `experimental `_: 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 601be67fe0..9e56d50ce2 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 -`experimental `: Restores the specified cluster. +`experimental `_: Restores the specified cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'createSharedClusterBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/createSharedClusterBackupRestoreJob diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt b/docs/command/atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob.txt index ed1c089772..6c2693704d 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 -`experimental `: Returns the specified restore job. +`experimental `_: Returns the specified restore job. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getSharedClusterBackupRestoreJob'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/getSharedClusterBackupRestoreJob diff --git a/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt b/docs/command/atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs.txt index 2b63fd6276..1921b45e12 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 -`experimental `: Returns all restore jobs for the specified M2 or M5 cluster. +`experimental `_: Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listSharedClusterBackupRestoreJobs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/listSharedClusterBackupRestoreJobs diff --git a/docs/command/atlas-api-sharedTierRestoreJobs.txt b/docs/command/atlas-api-sharedTierRestoreJobs.txt index 7697ace148..c130ee8c5e 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 -`experimental `: Returns and adds restore jobs for shared-tier database deployments. +`experimental `_: Returns and adds restore jobs for shared-tier database deployments. Options ------- @@ -49,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob` - `experimental `: Restores the specified cluster. -* :ref:`atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob` - `experimental `: Returns the specified restore job. -* :ref:`atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs` - `experimental `: Returns all restore jobs for the specified M2 or M5 cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-createSharedClusterBackupRestoreJob` - `experimental `_: Restores the specified cluster. +* :ref:`atlas-api-sharedTierRestoreJobs-getSharedClusterBackupRestoreJob` - `experimental `_: Returns the specified restore job. +* :ref:`atlas-api-sharedTierRestoreJobs-listSharedClusterBackupRestoreJobs` - `experimental `_: 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 4f34949e53..5dcca523b5 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 -`experimental `: Requests one snapshot for the specified shared cluster. +`experimental `_: Requests one snapshot for the specified shared cluster. This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'downloadSharedClusterBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/downloadSharedClusterBackup diff --git a/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt b/docs/command/atlas-api-sharedTierSnapshots-getSharedClusterBackup.txt index 483ce26132..66aec64aaa 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 -`experimental `: Returns details for one snapshot for the specified shared cluster. +`experimental `_: Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getSharedClusterBackup'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/getSharedClusterBackup diff --git a/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt b/docs/command/atlas-api-sharedTierSnapshots-listSharedClusterBackups.txt index b4ca12c5eb..04bc6f17ab 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 -`experimental `: Returns details for all snapshots for the specified shared cluster. +`experimental `_: Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listSharedClusterBackups'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/listSharedClusterBackups diff --git a/docs/command/atlas-api-sharedTierSnapshots.txt b/docs/command/atlas-api-sharedTierSnapshots.txt index 5ef58a1c4d..e3db419af2 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 -`experimental `: Returns and requests to download shared-tier database deployment snapshots. +`experimental `_: Returns and requests to download shared-tier database deployment snapshots. Options ------- @@ -49,9 +49,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-sharedTierSnapshots-downloadSharedClusterBackup` - `experimental `: Requests one snapshot for the specified shared cluster. -* :ref:`atlas-api-sharedTierSnapshots-getSharedClusterBackup` - `experimental `: Returns details for one snapshot for the specified shared cluster. -* :ref:`atlas-api-sharedTierSnapshots-listSharedClusterBackups` - `experimental `: Returns details for all snapshots for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-downloadSharedClusterBackup` - `experimental `_: Requests one snapshot for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-getSharedClusterBackup` - `experimental `_: Returns details for one snapshot for the specified shared cluster. +* :ref:`atlas-api-sharedTierSnapshots-listSharedClusterBackups` - `experimental `_: 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 a51fc213d5..b1f75051a9 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 -`experimental `: Requests the acceptance of an incoming VPC Peering connection. +`experimental `_: Requests the acceptance of an incoming VPC Peering connection. This command is invoking the endpoint with OperationID: 'acceptVpcPeeringConnection'. For more information about flags, format of --file and examples, see: 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 9702e2ba76..3b085bfd51 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 -`experimental `: Creates one Private Link in the specified project. +`experimental `_: Creates one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'createPrivateLinkConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createPrivateLinkConnection diff --git a/docs/command/atlas-api-streams-createStreamConnection.txt b/docs/command/atlas-api-streams-createStreamConnection.txt index 4cf0b77d06..9c3740b3b6 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 -`experimental `: Creates one connection for a stream instance in the specified project. +`experimental `_: Creates one connection for a stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'createStreamConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamConnection diff --git a/docs/command/atlas-api-streams-createStreamInstance.txt b/docs/command/atlas-api-streams-createStreamInstance.txt index f0cfea2719..22ec6d61e1 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 -`experimental `: Creates one stream instance in the specified project. +`experimental `_: Creates one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'createStreamInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstance diff --git a/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt b/docs/command/atlas-api-streams-createStreamInstanceWithSampleConnections.txt index ab47da65d2..36d7f06d2f 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 -`experimental `: Creates one stream instance in the specified project with sample connections. +`experimental `_: Creates one stream instance in the specified project with sample connections. To use this resource the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'createStreamInstanceWithSampleConnections'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstanceWithSampleConnections diff --git a/docs/command/atlas-api-streams-createStreamProcessor.txt b/docs/command/atlas-api-streams-createStreamProcessor.txt index 53d0e8425a..02e828a60c 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 -`experimental `: Create one Stream Processor within the specified stream instance. +`experimental `_: Create one Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'createStreamProcessor'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamProcessor diff --git a/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt b/docs/command/atlas-api-streams-deletePrivateLinkConnection.txt index 0533fc08ea..6e56aebd39 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 -`experimental `: Deletes one Private Link in the specified project. +`experimental `_: Deletes one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'deletePrivateLinkConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deletePrivateLinkConnection diff --git a/docs/command/atlas-api-streams-deleteStreamConnection.txt b/docs/command/atlas-api-streams-deleteStreamConnection.txt index 9c3df627dd..db5392c6b8 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 -`experimental `: Delete one connection of the specified stream instance. +`experimental `_: Delete one connection of the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'deleteStreamConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamConnection diff --git a/docs/command/atlas-api-streams-deleteStreamInstance.txt b/docs/command/atlas-api-streams-deleteStreamInstance.txt index cde7a2b2d2..a69ac43ee6 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 -`experimental `: Delete one stream instance in the specified project. +`experimental `_: Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'deleteStreamInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamInstance diff --git a/docs/command/atlas-api-streams-deleteStreamProcessor.txt b/docs/command/atlas-api-streams-deleteStreamProcessor.txt index 8696dd75be..68ad3454fc 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 -`experimental `: Delete a Stream Processor within the specified stream instance. +`experimental `_: Delete a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'deleteStreamProcessor'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamProcessor diff --git a/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt b/docs/command/atlas-api-streams-deleteVpcPeeringConnection.txt index 804fbc51c1..39d4ec47f0 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 -`experimental `: Deletes an incoming VPC Peering connection. +`experimental `_: Deletes an incoming VPC Peering connection. This command is invoking the endpoint with OperationID: 'deleteVpcPeeringConnection'. For more information about flags, format of --file and examples, see: 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 7c1f029503..3bed5a9b5b 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 -`experimental `: Downloads the audit logs for the specified Atlas Streams Processing instance. +`experimental `_: Downloads the audit logs for the specified Atlas Streams Processing instance. By default, logs cover periods of 30 days. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". This command is invoking the endpoint with OperationID: 'downloadStreamTenantAuditLogs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/downloadStreamTenantAuditLogs diff --git a/docs/command/atlas-api-streams-getAccountDetails.txt b/docs/command/atlas-api-streams-getAccountDetails.txt index 069b39ea35..b343a05c10 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 -`experimental `: Returns the Account ID, and the VPC ID for the group and region specified. +`experimental `_: Returns the Account ID, and the VPC ID for the group and region specified. This command is invoking the endpoint with OperationID: 'getAccountDetails'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getAccountDetails diff --git a/docs/command/atlas-api-streams-getPrivateLinkConnection.txt b/docs/command/atlas-api-streams-getPrivateLinkConnection.txt index 2f58dce7b4..fbfc10e3ac 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 -`experimental `: Returns the details of one Private Link connection within the project. +`experimental `_: Returns the details of one Private Link connection within the project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPrivateLinkConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getPrivateLinkConnection diff --git a/docs/command/atlas-api-streams-getStreamConnection.txt b/docs/command/atlas-api-streams-getStreamConnection.txt index ef1bfa71c6..e9d953dfd2 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 -`experimental `: Returns the details of one stream connection within the specified stream instance. +`experimental `_: Returns the details of one stream connection within the specified stream instance. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getStreamConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamConnection diff --git a/docs/command/atlas-api-streams-getStreamInstance.txt b/docs/command/atlas-api-streams-getStreamInstance.txt index 6e89f970e1..bd5170a4a3 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 -`experimental `: Returns the details of one stream instance within the specified project. +`experimental `_: Returns the details of one stream instance within the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'getStreamInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamInstance diff --git a/docs/command/atlas-api-streams-getStreamProcessor.txt b/docs/command/atlas-api-streams-getStreamProcessor.txt index 3187eaac7e..452c1953ad 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 -`experimental `: Get one Stream Processor within the specified stream instance. +`experimental `_: Get one Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'getStreamProcessor'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamProcessor diff --git a/docs/command/atlas-api-streams-getVpcPeeringConnections.txt b/docs/command/atlas-api-streams-getVpcPeeringConnections.txt index b1d911295e..53ff48b5ff 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 -`experimental `: Returns a list of incoming VPC Peering Connections. +`experimental `_: Returns a list of incoming VPC Peering Connections. This command is invoking the endpoint with OperationID: 'getVpcPeeringConnections'. For more information about flags, format of --file and examples, see: 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 2b35e2b82e..0139eb3372 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 -`experimental `: 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. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'listPrivateLinkConnections'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listPrivateLinkConnections diff --git a/docs/command/atlas-api-streams-listStreamConnections.txt b/docs/command/atlas-api-streams-listStreamConnections.txt index 9279ce3dd4..6ed0cbc74b 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 -`experimental `: 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. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'listStreamConnections'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamConnections diff --git a/docs/command/atlas-api-streams-listStreamInstances.txt b/docs/command/atlas-api-streams-listStreamInstances.txt index 4c255332ed..9403a463a5 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 -`experimental `: Returns all stream instances for the specified project. +`experimental `_: Returns all stream instances for the specified project. This command is invoking the endpoint with OperationID: 'listStreamInstances'. For more information about flags, format of --file and examples, see: 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 6ac63fd2c3..0b3fe51f4d 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 -`experimental `: Returns all Stream Processors within the specified stream instance. +`experimental `_: Returns all Stream Processors within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'listStreamProcessors'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamProcessors diff --git a/docs/command/atlas-api-streams-modifyStreamProcessor.txt b/docs/command/atlas-api-streams-modifyStreamProcessor.txt index 7b6d82bae5..b3b1b08cdc 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 -`experimental `: Modify one existing Stream Processor within the specified stream instance. +`experimental `_: Modify one existing Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'modifyStreamProcessor'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/modifyStreamProcessor diff --git a/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt b/docs/command/atlas-api-streams-rejectVpcPeeringConnection.txt index 1f1d17eca4..124942777b 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 -`experimental `: Requests the rejection of an incoming VPC Peering connection. +`experimental `_: Requests the rejection of an incoming VPC Peering connection. This command is invoking the endpoint with OperationID: 'rejectVpcPeeringConnection'. For more information about flags, format of --file and examples, see: 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 4ffadc2926..41a13c2e40 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 -`experimental `: Start a Stream Processor within the specified stream instance. +`experimental `_: Start a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'startStreamProcessor'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startStreamProcessor diff --git a/docs/command/atlas-api-streams-stopStreamProcessor.txt b/docs/command/atlas-api-streams-stopStreamProcessor.txt index 775fdffc66..7b7f412475 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 -`experimental `: Stop a Stream Processor within the specified stream instance. +`experimental `_: Stop a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'stopStreamProcessor'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/stopStreamProcessor diff --git a/docs/command/atlas-api-streams-updateStreamConnection.txt b/docs/command/atlas-api-streams-updateStreamConnection.txt index 6531ed31f9..d0958368a3 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 -`experimental `: Update one connection for the specified stream instance in the specified project. +`experimental `_: Update one connection for the specified stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'updateStreamConnection'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamConnection diff --git a/docs/command/atlas-api-streams-updateStreamInstance.txt b/docs/command/atlas-api-streams-updateStreamInstance.txt index 9219daa138..90495b4223 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 -`experimental `: Update one stream instance in the specified project. +`experimental `_: Update one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'updateStreamInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamInstance diff --git a/docs/command/atlas-api-streams.txt b/docs/command/atlas-api-streams.txt index 401860af72..6b43c6144c 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 -`experimental `: Returns, adds, edits, and removes Streams Instances. +`experimental `_: Returns, adds, edits, and removes Streams Instances. This resource requires your project ID. @@ -51,34 +51,34 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-streams-acceptVpcPeeringConnection` - `experimental `: Requests the acceptance of an incoming VPC Peering connection. -* :ref:`atlas-api-streams-createPrivateLinkConnection` - `experimental `: Creates one Private Link in the specified project. -* :ref:`atlas-api-streams-createStreamConnection` - `experimental `: Creates one connection for a stream instance in the specified project. -* :ref:`atlas-api-streams-createStreamInstance` - `experimental `: Creates one stream instance in the specified project. -* :ref:`atlas-api-streams-createStreamInstanceWithSampleConnections` - `experimental `: Creates one stream instance in the specified project with sample connections. -* :ref:`atlas-api-streams-createStreamProcessor` - `experimental `: Create one Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-deletePrivateLinkConnection` - `experimental `: Deletes one Private Link in the specified project. -* :ref:`atlas-api-streams-deleteStreamConnection` - `experimental `: Delete one connection of the specified stream instance. -* :ref:`atlas-api-streams-deleteStreamInstance` - `experimental `: Delete one stream instance in the specified project. -* :ref:`atlas-api-streams-deleteStreamProcessor` - `experimental `: Delete a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-deleteVpcPeeringConnection` - `experimental `: Deletes an incoming VPC Peering connection. -* :ref:`atlas-api-streams-downloadStreamTenantAuditLogs` - `experimental `: Downloads the audit logs for the specified Atlas Streams Processing instance. -* :ref:`atlas-api-streams-getAccountDetails` - `experimental `: Returns the Account ID, and the VPC ID for the group and region specified. -* :ref:`atlas-api-streams-getPrivateLinkConnection` - `experimental `: Returns the details of one Private Link connection within the project. -* :ref:`atlas-api-streams-getStreamConnection` - `experimental `: Returns the details of one stream connection within the specified stream instance. -* :ref:`atlas-api-streams-getStreamInstance` - `experimental `: Returns the details of one stream instance within the specified project. -* :ref:`atlas-api-streams-getStreamProcessor` - `experimental `: Get one Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-getVpcPeeringConnections` - `experimental `: Returns a list of incoming VPC Peering Connections. -* :ref:`atlas-api-streams-listPrivateLinkConnections` - `experimental `: 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. -* :ref:`atlas-api-streams-listStreamConnections` - `experimental `: 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. -* :ref:`atlas-api-streams-listStreamInstances` - `experimental `: Returns all stream instances for the specified project. -* :ref:`atlas-api-streams-listStreamProcessors` - `experimental `: Returns all Stream Processors within the specified stream instance. -* :ref:`atlas-api-streams-modifyStreamProcessor` - `experimental `: Modify one existing Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-rejectVpcPeeringConnection` - `experimental `: Requests the rejection of an incoming VPC Peering connection. -* :ref:`atlas-api-streams-startStreamProcessor` - `experimental `: Start a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-stopStreamProcessor` - `experimental `: Stop a Stream Processor within the specified stream instance. -* :ref:`atlas-api-streams-updateStreamConnection` - `experimental `: Update one connection for the specified stream instance in the specified project. -* :ref:`atlas-api-streams-updateStreamInstance` - `experimental `: Update one stream instance in the specified project. +* :ref:`atlas-api-streams-acceptVpcPeeringConnection` - `experimental `_: Requests the acceptance of an incoming VPC Peering connection. +* :ref:`atlas-api-streams-createPrivateLinkConnection` - `experimental `_: Creates one Private Link in the specified project. +* :ref:`atlas-api-streams-createStreamConnection` - `experimental `_: Creates one connection for a stream instance in the specified project. +* :ref:`atlas-api-streams-createStreamInstance` - `experimental `_: Creates one stream instance in the specified project. +* :ref:`atlas-api-streams-createStreamInstanceWithSampleConnections` - `experimental `_: Creates one stream instance in the specified project with sample connections. +* :ref:`atlas-api-streams-createStreamProcessor` - `experimental `_: Create one Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-deletePrivateLinkConnection` - `experimental `_: Deletes one Private Link in the specified project. +* :ref:`atlas-api-streams-deleteStreamConnection` - `experimental `_: Delete one connection of the specified stream instance. +* :ref:`atlas-api-streams-deleteStreamInstance` - `experimental `_: Delete one stream instance in the specified project. +* :ref:`atlas-api-streams-deleteStreamProcessor` - `experimental `_: Delete a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-deleteVpcPeeringConnection` - `experimental `_: Deletes an incoming VPC Peering connection. +* :ref:`atlas-api-streams-downloadStreamTenantAuditLogs` - `experimental `_: Downloads the audit logs for the specified Atlas Streams Processing instance. +* :ref:`atlas-api-streams-getAccountDetails` - `experimental `_: Returns the Account ID, and the VPC ID for the group and region specified. +* :ref:`atlas-api-streams-getPrivateLinkConnection` - `experimental `_: Returns the details of one Private Link connection within the project. +* :ref:`atlas-api-streams-getStreamConnection` - `experimental `_: Returns the details of one stream connection within the specified stream instance. +* :ref:`atlas-api-streams-getStreamInstance` - `experimental `_: Returns the details of one stream instance within the specified project. +* :ref:`atlas-api-streams-getStreamProcessor` - `experimental `_: Get one Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-getVpcPeeringConnections` - `experimental `_: Returns a list of incoming VPC Peering Connections. +* :ref:`atlas-api-streams-listPrivateLinkConnections` - `experimental `_: 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. +* :ref:`atlas-api-streams-listStreamConnections` - `experimental `_: 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. +* :ref:`atlas-api-streams-listStreamInstances` - `experimental `_: Returns all stream instances for the specified project. +* :ref:`atlas-api-streams-listStreamProcessors` - `experimental `_: Returns all Stream Processors within the specified stream instance. +* :ref:`atlas-api-streams-modifyStreamProcessor` - `experimental `_: Modify one existing Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-rejectVpcPeeringConnection` - `experimental `_: Requests the rejection of an incoming VPC Peering connection. +* :ref:`atlas-api-streams-startStreamProcessor` - `experimental `_: Start a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-stopStreamProcessor` - `experimental `_: Stop a Stream Processor within the specified stream instance. +* :ref:`atlas-api-streams-updateStreamConnection` - `experimental `_: Update one connection for the specified stream instance in the specified project. +* :ref:`atlas-api-streams-updateStreamInstance` - `experimental `_: 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 7f3b4efd2a..2e5cba9bd4 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 -`experimental `: Adds one team to the specified project. +`experimental `_: Adds one team to the specified project. All members of the team share the same project access. MongoDB Cloud limits the number of users to a maximum of 100 teams per project and a maximum of 250 teams per organization. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'addAllTeamsToProject'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addAllTeamsToProject diff --git a/docs/command/atlas-api-teams-addTeamUser.txt b/docs/command/atlas-api-teams-addTeamUser.txt index cc2a3687e1..c919157005 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 -`experimental `: Adds one or more MongoDB Cloud users from the specified organization to the specified team. +`experimental `_: Adds one or more MongoDB Cloud users from the specified organization to the specified team. Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'addTeamUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addTeamUser diff --git a/docs/command/atlas-api-teams-createTeam.txt b/docs/command/atlas-api-teams-createTeam.txt index c01446f955..0950f2203e 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 -`experimental `: Creates one team in the specified organization. +`experimental `_: Creates one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits the number of teams to a maximum of 250 teams per organization. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'createTeam'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/createTeam diff --git a/docs/command/atlas-api-teams-deleteTeam.txt b/docs/command/atlas-api-teams-deleteTeam.txt index 4d1df65821..7941177ffe 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 -`experimental `: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. +`experimental `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'deleteTeam'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/deleteTeam diff --git a/docs/command/atlas-api-teams-getTeamById.txt b/docs/command/atlas-api-teams-getTeamById.txt index 5a794de7cd..3e376e71f3 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 -`experimental `: Returns one team that you identified using its unique 24-hexadecimal digit ID. +`experimental `_: Returns one team that you identified using its unique 24-hexadecimal digit ID. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'getTeamById'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamById diff --git a/docs/command/atlas-api-teams-getTeamByName.txt b/docs/command/atlas-api-teams-getTeamByName.txt index 8648106881..ac784c18dd 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 -`experimental `: Returns one team that you identified using its human-readable name. +`experimental `_: Returns one team that you identified using its human-readable name. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'getTeamByName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamByName diff --git a/docs/command/atlas-api-teams-listOrganizationTeams.txt b/docs/command/atlas-api-teams-listOrganizationTeams.txt index b21a5b55f0..63f8e27e6e 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 -`experimental `: Returns all teams that belong to the specified organization. +`experimental `_: Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listOrganizationTeams'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listOrganizationTeams diff --git a/docs/command/atlas-api-teams-listProjectTeams.txt b/docs/command/atlas-api-teams-listProjectTeams.txt index a4ceda61ca..2c54cdd622 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 -`experimental `: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. +`experimental `_: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listProjectTeams'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listProjectTeams diff --git a/docs/command/atlas-api-teams-listTeamUsers.txt b/docs/command/atlas-api-teams-listTeamUsers.txt index c82946fb99..4f3cd3b247 100644 --- a/docs/command/atlas-api-teams-listTeamUsers.txt +++ b/docs/command/atlas-api-teams-listTeamUsers.txt @@ -12,7 +12,7 @@ atlas api teams listTeamUsers :depth: 1 :class: singlecol -`experimental `: Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. +`experimental `_: Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'listTeamUsers'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listTeamUsers diff --git a/docs/command/atlas-api-teams-removeProjectTeam.txt b/docs/command/atlas-api-teams-removeProjectTeam.txt index 685c96f12f..133d4408fa 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 -`experimental `: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. +`experimental `_: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'removeProjectTeam'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeProjectTeam diff --git a/docs/command/atlas-api-teams-removeTeamUser.txt b/docs/command/atlas-api-teams-removeTeamUser.txt index 722a4e281f..007a68ca83 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 -`experimental `: Removes one MongoDB Cloud user from the specified team. +`experimental `_: Removes one MongoDB Cloud user from the specified team. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'removeTeamUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeTeamUser diff --git a/docs/command/atlas-api-teams-renameTeam.txt b/docs/command/atlas-api-teams-renameTeam.txt index 2be18fe45c..a95e9948b5 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 -`experimental `: Renames one team in the specified organization. +`experimental `_: Renames one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Owner role. This command is invoking the endpoint with OperationID: 'renameTeam'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/renameTeam diff --git a/docs/command/atlas-api-teams-updateTeamRoles.txt b/docs/command/atlas-api-teams-updateTeamRoles.txt index 15af5a5c95..23d4f39a22 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 -`experimental `: Updates the project roles assigned to the specified team. +`experimental `_: Updates the project roles assigned to the specified team. You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'updateTeamRoles'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/updateTeamRoles diff --git a/docs/command/atlas-api-teams.txt b/docs/command/atlas-api-teams.txt index bd5f7b2743..e75503a967 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 -`experimental `: Returns, adds, edits, or removes teams. +`experimental `_: Returns, adds, edits, or removes teams. Options ------- @@ -49,19 +49,19 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-teams-addAllTeamsToProject` - `experimental `: Adds one team to the specified project. -* :ref:`atlas-api-teams-addTeamUser` - `experimental `: Adds one or more MongoDB Cloud users from the specified organization to the specified team. -* :ref:`atlas-api-teams-createTeam` - `experimental `: Creates one team in the specified organization. -* :ref:`atlas-api-teams-deleteTeam` - `experimental `: 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` - `experimental `: Returns one team that you identified using its unique 24-hexadecimal digit ID. -* :ref:`atlas-api-teams-getTeamByName` - `experimental `: Returns one team that you identified using its human-readable name. -* :ref:`atlas-api-teams-listOrganizationTeams` - `experimental `: Returns all teams that belong to the specified organization. -* :ref:`atlas-api-teams-listProjectTeams` - `experimental `: 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-listTeamUsers` - `experimental `: Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. -* :ref:`atlas-api-teams-removeProjectTeam` - `experimental `: 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` - `experimental `: Removes one MongoDB Cloud user from the specified team. -* :ref:`atlas-api-teams-renameTeam` - `experimental `: Renames one team in the specified organization. -* :ref:`atlas-api-teams-updateTeamRoles` - `experimental `: Updates the project roles assigned to the specified team. +* :ref:`atlas-api-teams-addAllTeamsToProject` - `experimental `_: Adds one team to the specified project. +* :ref:`atlas-api-teams-addTeamUser` - `experimental `_: Adds one or more MongoDB Cloud users from the specified organization to the specified team. +* :ref:`atlas-api-teams-createTeam` - `experimental `_: Creates one team in the specified organization. +* :ref:`atlas-api-teams-deleteTeam` - `experimental `_: 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` - `experimental `_: Returns one team that you identified using its unique 24-hexadecimal digit ID. +* :ref:`atlas-api-teams-getTeamByName` - `experimental `_: Returns one team that you identified using its human-readable name. +* :ref:`atlas-api-teams-listOrganizationTeams` - `experimental `_: Returns all teams that belong to the specified organization. +* :ref:`atlas-api-teams-listProjectTeams` - `experimental `_: 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-listTeamUsers` - `experimental `_: Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. +* :ref:`atlas-api-teams-removeProjectTeam` - `experimental `_: 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` - `experimental `_: Removes one MongoDB Cloud user from the specified team. +* :ref:`atlas-api-teams-renameTeam` - `experimental `_: Renames one team in the specified organization. +* :ref:`atlas-api-teams-updateTeamRoles` - `experimental `_: Updates the project roles assigned to the specified team. .. toctree:: diff --git a/docs/command/atlas-api-test-versionedExample.txt b/docs/command/atlas-api-test-versionedExample.txt index 84687f54e3..88ca4335de 100644 --- a/docs/command/atlas-api-test-versionedExample.txt +++ b/docs/command/atlas-api-test-versionedExample.txt @@ -12,7 +12,7 @@ atlas api test versionedExample :depth: 1 :class: singlecol -`experimental `: Returns some text dummy data for test purposes. +`experimental `_: Returns some text dummy data for test purposes. This command is invoking the endpoint with OperationID: 'versionedExample'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Test/operation/versionedExample diff --git a/docs/command/atlas-api-test.txt b/docs/command/atlas-api-test.txt index 01292bdebf..4588048cd2 100644 --- a/docs/command/atlas-api-test.txt +++ b/docs/command/atlas-api-test.txt @@ -12,7 +12,7 @@ atlas api test :depth: 1 :class: singlecol -`experimental `: Atlas test endpoints. +`experimental `_: Atlas test endpoints. Options ------- @@ -49,7 +49,7 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-test-versionedExample` - `experimental `: Returns some text dummy data for test purposes. +* :ref:`atlas-api-test-versionedExample` - `experimental `_: Returns some text dummy data for test purposes. .. toctree:: diff --git a/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-createThirdPartyIntegration.txt index f9c39a75a2..1b9ebb0083 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 -`experimental `: Adds the settings for configuring one third-party service integration. +`experimental `_: Adds the settings for configuring one third-party service integration. These settings apply to all databases managed in the specified MongoDB Cloud project. Each project can have only one configuration per {INTEGRATION-TYPE}. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This command is invoking the endpoint with OperationID: 'createThirdPartyIntegration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/createThirdPartyIntegration diff --git a/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration.txt index 6737d5312d..62511cae0d 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 -`experimental `: Removes the settings that permit configuring one third-party service integration. +`experimental `_: Removes the settings that permit configuring one third-party service integration. These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured {INTEGRATION-TYPE} integrations. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This command is invoking the endpoint with OperationID: 'deleteThirdPartyIntegration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/deleteThirdPartyIntegration diff --git a/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-getThirdPartyIntegration.txt index a402c23387..a4e97e1749 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 -`experimental `: Returns the settings for configuring integration with one third-party service. +`experimental `_: Returns the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This command is invoking the endpoint with OperationID: 'getThirdPartyIntegration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/getThirdPartyIntegration diff --git a/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations.txt index 1a12163f81..7ad4c0dc0e 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 -`experimental `: Returns the settings that permit integrations with all configured third-party services. +`experimental `_: Returns the settings that permit integrations with all configured third-party services. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This command is invoking the endpoint with OperationID: 'listThirdPartyIntegrations'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/listThirdPartyIntegrations diff --git a/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt b/docs/command/atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration.txt index 14680f5d3a..322bc2d253 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 -`experimental `: Updates the settings for configuring integration with one third-party service. +`experimental `_: Updates the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This command is invoking the endpoint with OperationID: 'updateThirdPartyIntegration'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/updateThirdPartyIntegration diff --git a/docs/command/atlas-api-thirdPartyIntegrations.txt b/docs/command/atlas-api-thirdPartyIntegrations.txt index dee51ace8b..55c8a1bff3 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 -`experimental `: Returns, adds, edits, and removes third-party service integration configurations. +`experimental `_: Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure. IMPORTANT: Each project can only have one configuration per integrationType. @@ -51,11 +51,11 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-thirdPartyIntegrations-createThirdPartyIntegration` - `experimental `: Adds the settings for configuring one third-party service integration. -* :ref:`atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration` - `experimental `: Removes the settings that permit configuring one third-party service integration. -* :ref:`atlas-api-thirdPartyIntegrations-getThirdPartyIntegration` - `experimental `: Returns the settings for configuring integration with one third-party service. -* :ref:`atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations` - `experimental `: Returns the settings that permit integrations with all configured third-party services. -* :ref:`atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration` - `experimental `: Updates the settings for configuring integration with one third-party service. +* :ref:`atlas-api-thirdPartyIntegrations-createThirdPartyIntegration` - `experimental `_: Adds the settings for configuring one third-party service integration. +* :ref:`atlas-api-thirdPartyIntegrations-deleteThirdPartyIntegration` - `experimental `_: Removes the settings that permit configuring one third-party service integration. +* :ref:`atlas-api-thirdPartyIntegrations-getThirdPartyIntegration` - `experimental `_: Returns the settings for configuring integration with one third-party service. +* :ref:`atlas-api-thirdPartyIntegrations-listThirdPartyIntegrations` - `experimental `_: Returns the settings that permit integrations with all configured third-party services. +* :ref:`atlas-api-thirdPartyIntegrations-updateThirdPartyIntegration` - `experimental `_: 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 53e0d072e5..c92398f58f 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 -`experimental `: Generates one X.509 certificate for the specified MongoDB user. +`experimental `_: Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting API Key must have the Project Owner role. To get MongoDB Cloud to generate a managed certificate for a database user, set "x509Type" : "MANAGED" on the desired MongoDB Database User. If you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA. This command is invoking the endpoint with OperationID: 'createDatabaseUserCertificate'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/createDatabaseUserCertificate diff --git a/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt b/docs/command/atlas-api-x509Authentication-disableCustomerManagedX509.txt index d35427b1c5..3927bc7e96 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 -`experimental `: Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509. +`experimental `_: 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. This command is invoking the endpoint with OperationID: 'disableCustomerManagedX509'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/disableCustomerManagedX509 diff --git a/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt b/docs/command/atlas-api-x509Authentication-listDatabaseUserCertificates.txt index 2dc17740a3..4f6b39f297 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 -`experimental `: Returns all unexpired X.509 certificates for the specified MongoDB user. +`experimental `_: Returns all unexpired X.509 certificates for the specified MongoDB user. This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listDatabaseUserCertificates'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/listDatabaseUserCertificates diff --git a/docs/command/atlas-api-x509Authentication.txt b/docs/command/atlas-api-x509Authentication.txt index b7c4307072..74e058f9ae 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 -`experimental `: Returns, edits, and removes user-managed X.509 configurations. +`experimental `_: 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 +51,9 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-x509Authentication-createDatabaseUserCertificate` - `experimental `: Generates one X.509 certificate for the specified MongoDB user. -* :ref:`atlas-api-x509Authentication-disableCustomerManagedX509` - `experimental `: 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` - `experimental `: Returns all unexpired X.509 certificates for the specified MongoDB user. +* :ref:`atlas-api-x509Authentication-createDatabaseUserCertificate` - `experimental `_: Generates one X.509 certificate for the specified MongoDB user. +* :ref:`atlas-api-x509Authentication-disableCustomerManagedX509` - `experimental `_: 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` - `experimental `_: 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 95673a69f7..74fbfa0d30 100644 --- a/docs/command/atlas-api.txt +++ b/docs/command/atlas-api.txt @@ -12,7 +12,7 @@ atlas api :depth: 1 :class: singlecol -`experimental `: Interact directly with any Atlas Admin API endpoint through the Atlas CLI, streamlining script development. +`experimental `_: Interact directly with any Atlas Admin API endpoint through the Atlas CLI, streamlining script development. Options ------- @@ -49,58 +49,58 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-api-accessTracking` - `experimental `: Returns access logs for authentication attempts made to Atlas database deployments. -* :ref:`atlas-api-alertConfigurations` - `experimental `: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. -* :ref:`atlas-api-alerts` - `experimental `: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. -* :ref:`atlas-api-atlasSearch` - `experimental `: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. -* :ref:`atlas-api-auditing` - `experimental `: Returns and edits database auditing settings for MongoDB Cloud projects. -* :ref:`atlas-api-awsClustersDns` - `experimental `: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. -* :ref:`atlas-api-cloudBackups` - `experimental `: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. -* :ref:`atlas-api-cloudMigrationService` - `experimental `: Manages the Cloud Migration Service. -* :ref:`atlas-api-cloudProviderAccess` - `experimental `: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. -* :ref:`atlas-api-clusterOutageSimulation` - `experimental `: Returns, starts, or ends a cluster outage simulation. -* :ref:`atlas-api-clusters` - `experimental `: Returns, adds, edits, and removes database deployments. -* :ref:`atlas-api-collectionLevelMetrics` - `experimental `: Returns, adds, and edits pinned namespaces for the specified cluster or process. -* :ref:`atlas-api-customDatabaseRoles` - `experimental `: Returns, adds, edits, and removes custom database user privilege roles. -* :ref:`atlas-api-dataFederation` - `experimental `: Returns, adds, edits, and removes Federated Database Instances. -* :ref:`atlas-api-dataLakePipelines` - `experimental `: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. -* :ref:`atlas-api-databaseUsers` - `experimental `: Returns, adds, edits, and removes database users. -* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement` - `experimental `: Returns and edits the Encryption at Rest using Customer Key Management configuration. -* :ref:`atlas-api-events` - `experimental `: Returns events. -* :ref:`atlas-api-federatedAuthentication` - `experimental `: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. -* :ref:`atlas-api-flexClusters` - `experimental `: Returns, adds, edits, and removes flex clusters. -* :ref:`atlas-api-flexRestoreJobs` - `experimental `: Returns and adds restore jobs for flex database deployments. -* :ref:`atlas-api-flexSnapshots` - `experimental `: Returns and requests to download flex database deployment snapshots. -* :ref:`atlas-api-globalClusters` - `experimental `: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. -* :ref:`atlas-api-invoices` - `experimental `: Returns invoices. -* :ref:`atlas-api-ldapConfiguration` - `experimental `: Returns, edits, verifies, and removes LDAP configurations. -* :ref:`atlas-api-legacyBackup` - `experimental `: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. -* :ref:`atlas-api-maintenanceWindows` - `experimental `: Returns, edits, and removes maintenance windows. -* :ref:`atlas-api-mongoDbCloudUsers` - `experimental `: Returns, adds, and edits MongoDB Cloud users. -* :ref:`atlas-api-monitoringAndLogs` - `experimental `: Returns database deployment monitoring and logging data. -* :ref:`atlas-api-networkPeering` - `experimental `: Returns, adds, edits, and removes network peering containers and peering connections. -* :ref:`atlas-api-onlineArchive` - `experimental `: Returns, adds, edits, or removes an online archive. -* :ref:`atlas-api-openApi` - `experimental `: Returns information about the MongoDB Atlas Specification. -* :ref:`atlas-api-organizations` - `experimental `: Returns, adds, and edits organizational units in MongoDB Cloud. -* :ref:`atlas-api-performanceAdvisor` - `experimental `: Returns suggested indexes and slow query data for a database deployment. -* :ref:`atlas-api-privateEndpointServices` - `experimental `: Returns, adds, edits, and removes private endpoint services. -* :ref:`atlas-api-programmaticApiKeys` - `experimental `: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. -* :ref:`atlas-api-projectIpAccessList` - `experimental `: Returns, adds, edits, and removes network access limits to database deployments in Atlas. -* :ref:`atlas-api-projects` - `experimental `: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. -* :ref:`atlas-api-pushBasedLogExport` - `experimental `: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. -* :ref:`atlas-api-resourcePolicies` - `experimental `: Configure and manage Atlas Resource Policies within your organization. -* :ref:`atlas-api-rollingIndex` - `experimental `: Creates one index to a database deployment in a rolling manner. -* :ref:`atlas-api-root` - `experimental `: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. -* :ref:`atlas-api-serverlessInstances` - `experimental `: Returns, adds, edits, and removes serverless instances. -* :ref:`atlas-api-serverlessPrivateEndpoints` - `experimental `: Returns, adds, edits, and removes private endpoints for serverless instances. -* :ref:`atlas-api-serviceAccounts` - `experimental `: Endpoints for managing Service Accounts and secrets. -* :ref:`atlas-api-sharedTierRestoreJobs` - `experimental `: Returns and adds restore jobs for shared-tier database deployments. -* :ref:`atlas-api-sharedTierSnapshots` - `experimental `: Returns and requests to download shared-tier database deployment snapshots. -* :ref:`atlas-api-streams` - `experimental `: Returns, adds, edits, and removes Streams Instances. -* :ref:`atlas-api-teams` - `experimental `: Returns, adds, edits, or removes teams. -* :ref:`atlas-api-test` - `experimental `: Atlas test endpoints. -* :ref:`atlas-api-thirdPartyIntegrations` - `experimental `: Returns, adds, edits, and removes third-party service integration configurations. -* :ref:`atlas-api-x509Authentication` - `experimental `: Returns, edits, and removes user-managed X.509 configurations. +* :ref:`atlas-api-accessTracking` - `experimental `_: Returns access logs for authentication attempts made to Atlas database deployments. +* :ref:`atlas-api-alertConfigurations` - `experimental `_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. +* :ref:`atlas-api-alerts` - `experimental `_: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. +* :ref:`atlas-api-atlasSearch` - `experimental `_: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. +* :ref:`atlas-api-auditing` - `experimental `_: Returns and edits database auditing settings for MongoDB Cloud projects. +* :ref:`atlas-api-awsClustersDns` - `experimental `_: Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. +* :ref:`atlas-api-cloudBackups` - `experimental `_: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. +* :ref:`atlas-api-cloudMigrationService` - `experimental `_: Manages the Cloud Migration Service. +* :ref:`atlas-api-cloudProviderAccess` - `experimental `_: Returns, adds, authorizes, and removes AWS IAM roles in Atlas. +* :ref:`atlas-api-clusterOutageSimulation` - `experimental `_: Returns, starts, or ends a cluster outage simulation. +* :ref:`atlas-api-clusters` - `experimental `_: Returns, adds, edits, and removes database deployments. +* :ref:`atlas-api-collectionLevelMetrics` - `experimental `_: Returns, adds, and edits pinned namespaces for the specified cluster or process. +* :ref:`atlas-api-customDatabaseRoles` - `experimental `_: Returns, adds, edits, and removes custom database user privilege roles. +* :ref:`atlas-api-dataFederation` - `experimental `_: Returns, adds, edits, and removes Federated Database Instances. +* :ref:`atlas-api-dataLakePipelines` - `experimental `_: Returns, edits, and removes Atlas Data Lake Pipelines and associated runs. +* :ref:`atlas-api-databaseUsers` - `experimental `_: Returns, adds, edits, and removes database users. +* :ref:`atlas-api-encryptionAtRestUsingCustomerKeyManagement` - `experimental `_: Returns and edits the Encryption at Rest using Customer Key Management configuration. +* :ref:`atlas-api-events` - `experimental `_: Returns events. +* :ref:`atlas-api-federatedAuthentication` - `experimental `_: Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. +* :ref:`atlas-api-flexClusters` - `experimental `_: Returns, adds, edits, and removes flex clusters. +* :ref:`atlas-api-flexRestoreJobs` - `experimental `_: Returns and adds restore jobs for flex database deployments. +* :ref:`atlas-api-flexSnapshots` - `experimental `_: Returns and requests to download flex database deployment snapshots. +* :ref:`atlas-api-globalClusters` - `experimental `_: Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. +* :ref:`atlas-api-invoices` - `experimental `_: Returns invoices. +* :ref:`atlas-api-ldapConfiguration` - `experimental `_: Returns, edits, verifies, and removes LDAP configurations. +* :ref:`atlas-api-legacyBackup` - `experimental `_: Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints. +* :ref:`atlas-api-maintenanceWindows` - `experimental `_: Returns, edits, and removes maintenance windows. +* :ref:`atlas-api-mongoDbCloudUsers` - `experimental `_: Returns, adds, and edits MongoDB Cloud users. +* :ref:`atlas-api-monitoringAndLogs` - `experimental `_: Returns database deployment monitoring and logging data. +* :ref:`atlas-api-networkPeering` - `experimental `_: Returns, adds, edits, and removes network peering containers and peering connections. +* :ref:`atlas-api-onlineArchive` - `experimental `_: Returns, adds, edits, or removes an online archive. +* :ref:`atlas-api-openApi` - `experimental `_: Returns information about the MongoDB Atlas Specification. +* :ref:`atlas-api-organizations` - `experimental `_: Returns, adds, and edits organizational units in MongoDB Cloud. +* :ref:`atlas-api-performanceAdvisor` - `experimental `_: Returns suggested indexes and slow query data for a database deployment. +* :ref:`atlas-api-privateEndpointServices` - `experimental `_: Returns, adds, edits, and removes private endpoint services. +* :ref:`atlas-api-programmaticApiKeys` - `experimental `_: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. +* :ref:`atlas-api-projectIpAccessList` - `experimental `_: Returns, adds, edits, and removes network access limits to database deployments in Atlas. +* :ref:`atlas-api-projects` - `experimental `_: Returns, adds, and edits collections of clusters and users in MongoDB Cloud. +* :ref:`atlas-api-pushBasedLogExport` - `experimental `_: You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. +* :ref:`atlas-api-resourcePolicies` - `experimental `_: Configure and manage Atlas Resource Policies within your organization. +* :ref:`atlas-api-rollingIndex` - `experimental `_: Creates one index to a database deployment in a rolling manner. +* :ref:`atlas-api-root` - `experimental `_: Returns details that describe the MongoDB Cloud build and the access token that requests this resource. +* :ref:`atlas-api-serverlessInstances` - `experimental `_: Returns, adds, edits, and removes serverless instances. +* :ref:`atlas-api-serverlessPrivateEndpoints` - `experimental `_: Returns, adds, edits, and removes private endpoints for serverless instances. +* :ref:`atlas-api-serviceAccounts` - `experimental `_: Endpoints for managing Service Accounts and secrets. +* :ref:`atlas-api-sharedTierRestoreJobs` - `experimental `_: Returns and adds restore jobs for shared-tier database deployments. +* :ref:`atlas-api-sharedTierSnapshots` - `experimental `_: Returns and requests to download shared-tier database deployment snapshots. +* :ref:`atlas-api-streams` - `experimental `_: Returns, adds, edits, and removes Streams Instances. +* :ref:`atlas-api-teams` - `experimental `_: Returns, adds, edits, or removes teams. +* :ref:`atlas-api-test` - `experimental `_: Atlas test endpoints. +* :ref:`atlas-api-thirdPartyIntegrations` - `experimental `_: Returns, adds, edits, and removes third-party service integration configurations. +* :ref:`atlas-api-x509Authentication` - `experimental `_: Returns, edits, and removes user-managed X.509 configurations. .. toctree:: diff --git a/docs/command/atlas.txt b/docs/command/atlas.txt index 7478b30a0a..464e23afcb 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` - `experimental `: Interact directly with any Atlas Admin API endpoint through the Atlas CLI, streamlining script development. +* :ref:`atlas-api` - `experimental `_: Interact directly with any Atlas Admin API endpoint through the Atlas CLI, streamlining script development. * :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/tools/docs/main.go b/tools/docs/main.go index 48feffc8e7..ba34d8d9a9 100644 --- a/tools/docs/main.go +++ b/tools/docs/main.go @@ -48,7 +48,7 @@ func addExperimenalToAPICommands(cmd *cobra.Command) { } func markExperimentalRecursively(cmd *cobra.Command) { - cmd.Short = "`experimental `: " + cmd.Short + cmd.Short = "`experimental `_: " + cmd.Short for _, subCommand := range cmd.Commands() { markExperimentalRecursively(subCommand)